Class SeamailDAO

Hierarchy

AbstractDAO
- SeamailDAO

Index

Constructors

constructor

Accessors

http

Methods

Constructors

constructor

new SeamailDAO(impl: ITwitarrHTTP | IHasHTTP): SeamailDAO

Inherited from AbstractDAO.constructor
- Defined in dao/AbstractDAO.ts:11
Construct a DAO instance.

Parameters
- impl: ITwitarrHTTP | IHasHTTP
  
  The HTTP implementation to use. It is also legal to pass any object conforming to the IHasHTTP interface (like a Client).
Returns SeamailDAO

Accessors

http

get http(): ITwitarrHTTP
set http(impl: ITwitarrHTTP): void

Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:29
The HTTP implementation to use internally when making DAO requests.

Returns ITwitarrHTTP
Inherited from AbstractDAO.http
- Defined in dao/AbstractDAO.ts:33
The HTTP implementation to use internally when making DAO requests.

Parameters
- impl: ITwitarrHTTP
Returns void

Methods

create

create(subject: string, message: string, ...users: string[]): Promise<SeamailResponse>

- Defined in dao/SeamailDAO.ts:58
Parameters
- subject: string
- message: string
- Rest ...users: string[]
Returns Promise<SeamailResponse>

get

get(id: string, skip_mark_read?: boolean): Promise<SeamailResponse>

- Defined in dao/SeamailDAO.ts:10
Parameters
- id: string
- Optional skip_mark_read: boolean
Returns Promise<SeamailResponse>

getMetadata

getMetadata(unread?: boolean, after?: Moment): Promise<SeamailResponse>

- Defined in dao/SeamailDAO.ts:26
Parameters
- Optional unread: boolean
- Optional after: Moment
Returns Promise<SeamailResponse>

getThreads

getThreads(unread?: boolean, exclude_read_messages?: boolean, after?: Moment): Promise<SeamailResponse>

- Defined in dao/SeamailDAO.ts:42
Parameters
- Optional unread: boolean
- Optional exclude_read_messages: boolean
- Optional after: Moment
Returns Promise<SeamailResponse>

Protected handleErrors

handleErrors(result: TwitarrResult<any>): any

Inherited from AbstractDAO.handleErrors
- Defined in dao/AbstractDAO.ts:37
Parameters
- result: TwitarrResult<any>
Returns any

post

post(id: string, message: string): Promise<SeamailMessage>

- Defined in dao/SeamailDAO.ts:70
Parameters
- id: string
- message: string
Returns Promise<SeamailMessage>

unreadCount

unreadCount(): Promise<any>

- Defined in dao/SeamailDAO.ts:78
Returns Promise<any>

Generated using TypeDoc