Class MessageStore

Hierarchy

UrlSection
- MessageStore

Index

Constructors

constructor

Methods

Constructors

constructor

new MessageStore(prv: PathSegment, id?: string, service?: any): MessageStore

Overrides UrlSection.constructor
- Defined in paths/MessageStore.ts:8
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns MessageStore

Methods

content

content(id?: string): Content

- Defined in paths/MessageStore.ts:15
Internal identifier of a message attachment

Parameters
- Optional id: string
Returns Content

delete

delete(query?: DeleteQuery): Promise<void>

- Defined in paths/MessageStore.ts:32
Parameters
- Optional query: DeleteQuery
Returns Promise<void>

get

get(): Promise<GetMessageInfoResponse>

- Defined in paths/MessageStore.ts:43
Since 1.0.2
Returns individual message record(s) by the given message ID(s). The length of inbound messages is unlimited. Batch request is supported, see Batch Requests for details.
Required Permissions
Permission Description
ReadMessages Viewing user messages
Usage Plan Group
Light

Returns Promise<GetMessageInfoResponse>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

list

list(query?: ListQuery): Promise<GetMessageList>

- Defined in paths/MessageStore.ts:22
Since 1.0.2
Returns the list of messages from an extension mailbox.
Required Permissions
Permission Description
ReadMessages Viewing user messages
Usage Plan Group
Light

Parameters
- Optional query: ListQuery
Returns Promise<GetMessageList>

put

put(body: UpdateMessageRequest): Promise<GetMessageInfoResponse>

- Defined in paths/MessageStore.ts:56
Since 1.0.2
Updates message(s) by ID(s). Batch request is supported, see Batch Requests for details. Currently, only the message read status updating is supported.
Required Permissions
Permission Description
EditMessages Viewing and updating user messages
ReadMessages Viewing user messages
Usage Plan Group
Medium

Parameters
- body: UpdateMessageRequest
Returns Promise<GetMessageInfoResponse>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc