Class Notifications

Hierarchy

Notifications

Index

Constructors

Methods

getNotification getNotificationBoard getNotificationCard getNotificationField getNotificationList getNotificationMember getNotificationMemberCreator getNotificationOrganization markAllNotificationsAsRead updateNotification updateNotificationReadStatus

Constructors

constructor

new Notifications(client): Notifications
Parameters
- client: Client
Returns Notifications
- Defined in api/notifications.ts:6

Properties

`Private` client

client: Client

Methods

getNotification

getNotification<T>(parameters, callback): Promise<void>
Type Parameters
- T = unknown
Parameters
- parameters: GetNotification
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:8
getNotification<T>(parameters, callback?): Promise<T>
Type Parameters
- T = unknown
Parameters
- parameters: GetNotification
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:9

getNotificationBoard

getNotificationBoard<T>(parameters, callback): Promise<void>
Get the board a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationBoard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:131
getNotificationBoard<T>(parameters, callback?): Promise<T>
Get the board a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationBoard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:136

getNotificationCard

getNotificationCard<T>(parameters, callback): Promise<void>
Get the card a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationCard
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:153
getNotificationCard<T>(parameters, callback?): Promise<T>
Get the card a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationCard
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:158

getNotificationField

getNotificationField<T>(parameters, callback): Promise<void>
Get a specific property of a notification
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationField
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:61
getNotificationField<T>(parameters, callback?): Promise<T>
Get a specific property of a notification
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationField
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:66

getNotificationList

getNotificationList<T>(parameters, callback): Promise<void>
Get the list a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationList
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:175
getNotificationList<T>(parameters, callback?): Promise<T>
Get the list a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationList
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:180

getNotificationMember

getNotificationMember<T>(parameters, callback): Promise<void>
Get the member (not the creator) a notification is about
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationMember
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:197
getNotificationMember<T>(parameters, callback?): Promise<T>
Get the member (not the creator) a notification is about
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationMember
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:202

getNotificationMemberCreator

getNotificationMemberCreator<T>(parameters, callback): Promise<void>
Get the member who created the notification
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationMemberCreator
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:219
getNotificationMemberCreator<T>(parameters, callback?): Promise<T>
Get the member who created the notification
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationMemberCreator
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:224

getNotificationOrganization

getNotificationOrganization<T>(parameters, callback): Promise<void>
Get the organization a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationOrganization
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:244
getNotificationOrganization<T>(parameters, callback?): Promise<T>
Get the organization a notification is associated with
Type Parameters
- T = unknown
Parameters
- parameters: GetNotificationOrganization
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:249

markAllNotificationsAsRead

markAllNotificationsAsRead<T>(parameters?, callback?): Promise<void>
Mark all notifications as read
Type Parameters
- T = unknown
Parameters
- Optional parameters: MarkAllNotificationsAsRead
- Optional callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:80
markAllNotificationsAsRead<T>(parameters?, callback?): Promise<T>
Mark all notifications as read
Type Parameters
- T = unknown
Parameters
- Optional parameters: MarkAllNotificationsAsRead
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:85

updateNotification

updateNotification<T>(parameters, callback): Promise<void>
Update the read status of a notification
Type Parameters
- T = unknown
Parameters
- parameters: UpdateNotification
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:39
updateNotification<T>(parameters, callback?): Promise<T>
Update the read status of a notification
Type Parameters
- T = unknown
Parameters
- parameters: UpdateNotification
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:44

updateNotificationReadStatus

updateNotificationReadStatus<T>(parameters, callback): Promise<void>
Update Notification's read status
Type Parameters
- T = unknown
Parameters
- parameters: UpdateNotificationReadStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in api/notifications.ts:106
updateNotificationReadStatus<T>(parameters, callback?): Promise<T>
Update Notification's read status
Type Parameters
- T = unknown
Parameters
- parameters: UpdateNotificationReadStatus
- Optional callback: undefined
Returns Promise<T>
- Defined in api/notifications.ts:111

Class Notifications

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

client: Client

Returns Notifications

Properties

Private client

Methods

getNotification

Type Parameters

T = unknown

Parameters

parameters: GetNotification

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: GetNotification

Optional callback: undefined

Returns Promise<T>

getNotificationBoard

Type Parameters

T = unknown

Parameters

parameters: GetNotificationBoard

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: GetNotificationBoard

Optional callback: undefined

Returns Promise<T>

getNotificationCard

Type Parameters

T = unknown

Parameters

parameters: GetNotificationCard

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: GetNotificationCard

Optional callback: undefined

Returns Promise<T>

getNotificationField

Type Parameters

T = unknown

Parameters

parameters: GetNotificationField

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: GetNotificationField

Optional callback: undefined

Returns Promise<T>

getNotificationList

Type Parameters

T = unknown

Parameters

parameters: GetNotificationList

callback: Callback<T>

Returns Promise<void>

Type Parameters

T = unknown

Parameters

parameters: GetNotificationList

Optional callback: undefined

Returns Promise<T>

getNotificationMember

`Private` client

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` callback: undefined

`Optional` parameters: MarkAllNotificationsAsRead

`Optional` callback: Callback<T>

`Optional` parameters: MarkAllNotificationsAsRead

`Optional` callback: undefined

`Optional` callback: undefined