Class: default

client/apis/PrivateMessagesAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• archiveMessages
• getAnnouncements
• getAnnouncementsMetaData
• getMessage
• getMessages
• getUnreadMessagesCount
• markMessagesRead
• markMessagesUnread
• request
• sendMessage
• unArchiveMessages

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

Defined in: client/apis/PrivateMessagesAPI.ts:90

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

archiveMessages

▸ archiveMessages(options: ArchiveMessagesOptions): Promise<ArchiveMessages>

Parameters:

Name	Type
options	ArchiveMessagesOptions

Returns: Promise<ArchiveMessages>

Defined in: client/apis/PrivateMessagesAPI.ts:154

---

getAnnouncements

▸ getAnnouncements(): Promise<GetAnnouncements>

Returns: Promise<GetAnnouncements>

Defined in: client/apis/PrivateMessagesAPI.ts:98

---

getAnnouncementsMetaData

▸ getAnnouncementsMetaData(): Promise<GetAnnouncementsMetaData>

Returns: Promise<GetAnnouncementsMetaData>

Defined in: client/apis/PrivateMessagesAPI.ts:109

---

getMessage

▸ getMessage(options: GetMessageOptions): Promise<{ body: string ; created: string ; id: number ; isRead: boolean ; isReportAbuseDisplayed: boolean ; isSystemMessage: boolean ; recipient: { displayName: string ; id: number ; name: string } ; sender: { displayName: string ; id: number ; name: string } ; subject: string ; updated: string }>

Parameters:

Name	Type
options	GetMessageOptions

Returns: Promise<{ body: string ; created: string ; id: number ; isRead: boolean ; isReportAbuseDisplayed: boolean ; isSystemMessage: boolean ; recipient: { displayName: string ; id: number ; name: string } ; sender: { displayName: string ; id: number ; name: string } ; subject: string ; updated: string }>

Defined in: client/apis/PrivateMessagesAPI.ts:132

---

getMessages

▸ getMessages(options: GetMessagesOptions): Promise<GetMessages>

Parameters:

Name	Type
options	GetMessagesOptions

Returns: Promise<GetMessages>

Defined in: client/apis/PrivateMessagesAPI.ts:120

---

getUnreadMessagesCount

▸ getUnreadMessagesCount(): Promise<GetUnreadMessagesCount>

Returns: Promise<GetUnreadMessagesCount>

Defined in: client/apis/PrivateMessagesAPI.ts:143

---

markMessagesRead

▸ markMessagesRead(options: ArchiveMessagesOptions): Promise<ArchiveMessages>

Parameters:

Name	Type
options	ArchiveMessagesOptions

Returns: Promise<ArchiveMessages>

Defined in: client/apis/PrivateMessagesAPI.ts:167

---

markMessagesUnread

▸ markMessagesUnread(options: ArchiveMessagesOptions): Promise<ArchiveMessages>

Parameters:

Name	Type
options	ArchiveMessagesOptions

Returns: Promise<ArchiveMessages>

Defined in: client/apis/PrivateMessagesAPI.ts:180

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

sendMessage

▸ sendMessage(options: SendMessageOptions): Promise<SendMessage>

Parameters:

Name	Type
options	SendMessageOptions

Returns: Promise<SendMessage>

Defined in: client/apis/PrivateMessagesAPI.ts:193

---

unArchiveMessages

▸ unArchiveMessages(options: ArchiveMessagesOptions): Promise<ArchiveMessages>

Parameters:

Name	Type
options	ArchiveMessagesOptions

Returns: Promise<ArchiveMessages>

Defined in: client/apis/PrivateMessagesAPI.ts:206