@tribeplatform/gql-client / Modules / clients / NotificationsClient

Class: NotificationsClient

clients.NotificationsClient

Table of contents

Constructors

• constructor

Methods

• clearNotificationsCount
• count
• deleteNotification
• deleteNotifications
• list
• memberPostNotificationSettings
• memberSettings
• readNotification
• readNotifications
• unsubscribe
• updateMemberPostNotificationSettings
• updateNetworkSettings
• updateSpaceSettings

Constructors

constructor

• new NotificationsClient(client)

Parameters

Name	Type
client	GraphqlClient

Defined in

packages/client/src/clients/notifications.client.ts:43

Methods

clearNotificationsCount

▸ clearNotificationsCount(fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/notifications.client.ts:126

---

count

▸ count(accessToken?): Promise<number>

Parameters

Name	Type
accessToken?	string

Returns

Promise<number>

Defined in

packages/client/src/clients/notifications.client.ts:47

---

deleteNotification

▸ deleteNotification(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationDeleteNotificationArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/notifications.client.ts:98

---

deleteNotifications

▸ deleteNotifications(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationDeleteNotificationsArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/notifications.client.ts:112

---

list

▸ list(variables?, fields?, accessToken?): Promise<PaginatedNotification>

Parameters

Name	Type	Default value
variables	QueryNotificationsArgs	undefined
fields	NotificationFields	'basic'
accessToken?	string	undefined

Returns

Promise<PaginatedNotification>

Defined in

packages/client/src/clients/notifications.client.ts:56

---

memberPostNotificationSettings

▸ memberPostNotificationSettings(variables): Promise<MemberPostNotificationSettings>

Parameters

Name	Type
variables	QueryMemberPostNotificationSettingsArgs

Returns

Promise<MemberPostNotificationSettings>

Defined in

packages/client/src/clients/notifications.client.ts:151

---

memberSettings

▸ memberSettings(variables): Promise<MemberNotificationSettings>

Parameters

Name	Type
variables	QueryMemberNotificationSettingsArgs

Returns

Promise<MemberNotificationSettings>

Defined in

packages/client/src/clients/notifications.client.ts:138

---

readNotification

▸ readNotification(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationReadNotificationArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/notifications.client.ts:70

---

readNotifications

▸ readNotifications(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationReadNotificationsArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/notifications.client.ts:84

---

unsubscribe

▸ unsubscribe(variables, fields?, accessToken?): Promise<Action>

Parameters

Name	Type	Default value
variables	MutationUnsubscribeFromNotificationArgs	undefined
fields	ActionFields	'basic'
accessToken?	string	undefined

Returns

Promise<Action>

Defined in

packages/client/src/clients/notifications.client.ts:203

---

updateMemberPostNotificationSettings

▸ updateMemberPostNotificationSettings(variables): Promise<MemberPostNotificationSettings>

Parameters

Name	Type
variables	MutationUpdateMemberPostNotificationSettingsArgs

Returns

Promise<MemberPostNotificationSettings>

Defined in

packages/client/src/clients/notifications.client.ts:164

---

updateNetworkSettings

▸ updateNetworkSettings(variables): Promise<MemberNetworkNotificationSettings>

Parameters

Name	Type
variables	MutationUpdateMemberNetworkNotificationSettingsArgs

Returns

Promise<MemberNetworkNotificationSettings>

Defined in

packages/client/src/clients/notifications.client.ts:190

---

updateSpaceSettings

▸ updateSpaceSettings(variables): Promise<MemberSpaceNotificationSettings>

Parameters

Name	Type
variables	MutationUpdateMemberSpaceNotificationSettingsArgs

Returns

Promise<MemberSpaceNotificationSettings>

Defined in

packages/client/src/clients/notifications.client.ts:177