Skip to content

Class: default

client/apis/NotificationsAPI.default

Hierarchy

↳ default

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new default(client: default): default

Parameters:

Name Type
client default

Returns: default

Inherited from: default

Defined in: client/apis/NotificationsAPI.ts:237

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

allowNotificationDestination

▸ allowNotificationDestination(options: AllowNotificationsDestinationOptions): Promise<unknown>

Parameters:

Name Type
options AllowNotificationsDestinationOptions

Returns: Promise<unknown>

Defined in: client/apis/NotificationsAPI.ts:293

allowNotificationSource

▸ allowNotificationSource(options: AllowNotificationSourceOptions): Promise<unknown>

Parameters:

Name Type
options AllowNotificationSourceOptions

Returns: Promise<unknown>

Defined in: client/apis/NotificationsAPI.ts:267

clearUnreadStreamNotifications

▸ clearUnreadStreamNotifications(): Promise<ClearUnreadStreamNotifications>

Returns: Promise<ClearUnreadStreamNotifications>

Defined in: client/apis/NotificationsAPI.ts:601

deregisterAllDevices

▸ deregisterAllDevices(): Promise<DeregisterAllDevices>

Returns: Promise<DeregisterAllDevices>

Defined in: client/apis/NotificationsAPI.ts:401

deregisterCurrentDevice

▸ deregisterCurrentDevice(): Promise<DeregisterCurrentDevice>

Returns: Promise<DeregisterCurrentDevice>

Defined in: client/apis/NotificationsAPI.ts:413

disallowNotificationDestination

▸ disallowNotificationDestination(options: AllowNotificationsDestinationOptions): Promise<unknown>

Parameters:

Name Type
options AllowNotificationsDestinationOptions

Returns: Promise<unknown>

Defined in: client/apis/NotificationsAPI.ts:306

disallowNotificationSource

▸ disallowNotificationSource(options: AllowNotificationSourceOptions): Promise<unknown>

Parameters:

Name Type
options AllowNotificationSourceOptions

Returns: Promise<unknown>

Defined in: client/apis/NotificationsAPI.ts:280

getChromeManifest

▸ getChromeManifest(): Promise<GetChromeNotificationsManifest>

Returns: Promise<GetChromeNotificationsManifest>

Defined in: client/apis/NotificationsAPI.ts:345

getCurrentDeviceDestination

▸ getCurrentDeviceDestination(): Promise<GetCurrentNotificationDeviceDestination>

Returns: Promise<GetCurrentNotificationDeviceDestination>

Defined in: client/apis/NotificationsAPI.ts:356

getDestinations

▸ getDestinations(): Promise<GetNotificationDestinations>

Returns: Promise<GetNotificationDestinations>

Defined in: client/apis/NotificationsAPI.ts:367

getLatestUniversesUpdates

▸ getLatestUniversesUpdates(options: GetLatestUniversesUpdatesOptions): Promise<GetLatestUniverseUpdates>

Parameters:

Name Type
options GetLatestUniversesUpdatesOptions

Returns: Promise<GetLatestUniverseUpdates>

Defined in: client/apis/NotificationsAPI.ts:541

getNotificationIds

▸ getNotificationIds(options: GetNotificationIdsOptions): Promise<GetNotificationIds>

Parameters:

Name Type
options GetNotificationIdsOptions

Returns: Promise<GetNotificationIds>

Defined in: client/apis/NotificationsAPI.ts:389

getNotificationsSettings

▸ getNotificationsSettings(): Promise<GetNotificationsSettings>

Returns: Promise<GetNotificationsSettings>

Defined in: client/apis/NotificationsAPI.ts:245

getPushNotificationsMetaData

▸ getPushNotificationsMetaData(): Promise<GetNotificationsMetaData>

Returns: Promise<GetNotificationsMetaData>

Defined in: client/apis/NotificationsAPI.ts:378

getRealtimeNotificationSettings

▸ getRealtimeNotificationSettings(): Promise<GetRealtimeNotificationsSettings>

Returns: Promise<GetRealtimeNotificationsSettings>

Defined in: client/apis/NotificationsAPI.ts:256

getRecentStreamNotifications

▸ getRecentStreamNotifications(options: GetRecentStreamNotificationsOptions): Promise<GetRecentStreamNotifications>

Parameters:

Name Type
options GetRecentStreamNotificationsOptions

Returns: Promise<GetRecentStreamNotifications>

Defined in: client/apis/NotificationsAPI.ts:567

getStreamNotificationsMetaData

▸ getStreamNotificationsMetaData(): Promise<GetLatestUniverseUpdates>

Returns: Promise<GetLatestUniverseUpdates>

Defined in: client/apis/NotificationsAPI.ts:579

getStreamNotificationsPromptSettings

▸ getStreamNotificationsPromptSettings(): Promise<GetStreamNotificationsPromptSettings>

Returns: Promise<GetStreamNotificationsPromptSettings>

Defined in: client/apis/NotificationsAPI.ts:556

getUnreadStreamNotificationsCount

▸ getUnreadStreamNotificationsCount(): Promise<GetLatestUniverseUpdates>

Returns: Promise<GetLatestUniverseUpdates>

Defined in: client/apis/NotificationsAPI.ts:590

markGameUpdateNotificationInteracted

▸ markGameUpdateNotificationInteracted(options: SendGameUpdateNotificationInteractedOptions): Promise<SendGameUpdateNotificationInteracted>

Parameters:

Name Type
options SendGameUpdateNotificationInteractedOptions

Returns: Promise<SendGameUpdateNotificationInteracted>

Defined in: client/apis/NotificationsAPI.ts:613

markGameUpdateNotificationRead

▸ markGameUpdateNotificationRead(options: SendGameUpdateNotificationReadOptions): Promise<SendGameUpdateNotificationRead>

Parameters:

Name Type
options SendGameUpdateNotificationReadOptions

Returns: Promise<SendGameUpdateNotificationRead>

Defined in: client/apis/NotificationsAPI.ts:626

markNotificationCategoryRead

▸ markNotificationCategoryRead(options: MarkNotificationCategoryReadOptions): Promise<MarkNotificationCategoryRead>

Parameters:

Name Type
options MarkNotificationCategoryReadOptions

Returns: Promise<MarkNotificationCategoryRead>

Defined in: client/apis/NotificationsAPI.ts:437

markNotificationInteraction

▸ markNotificationInteraction(options: MarkNotificationInteractionOptions): Promise<MarkNotificationInteraction>

Parameters:

Name Type
options MarkNotificationInteractionOptions

Returns: Promise<MarkNotificationInteraction>

Defined in: client/apis/NotificationsAPI.ts:450

markNotificationRead

▸ markNotificationRead(options: MarkNotificationReadOptions): Promise<MarkNotificationRead>

Parameters:

Name Type
options MarkNotificationReadOptions

Returns: Promise<MarkNotificationRead>

Defined in: client/apis/NotificationsAPI.ts:424

registerAndroidAmazon

▸ registerAndroidAmazon(options: RegisterAmazonAndroidOptions): Promise<RegisterAmazonAndroid>

Parameters:

Name Type
options RegisterAmazonAndroidOptions

Returns: Promise<RegisterAmazonAndroid>

Defined in: client/apis/NotificationsAPI.ts:463

registerAndroidNative

▸ registerAndroidNative(options: RegisterAmazonAndroidOptions): Promise<RegisterAmazonAndroid>

Parameters:

Name Type
options RegisterAmazonAndroidOptions

Returns: Promise<RegisterAmazonAndroid>

Defined in: client/apis/NotificationsAPI.ts:476

registerAndroidTencentSerice

▸ registerAndroidTencentSerice(options: RegisterAmazonAndroidOptions): Promise<RegisterAmazonAndroid>

Parameters:

Name Type
options RegisterAmazonAndroidOptions

Returns: Promise<RegisterAmazonAndroid>

Defined in: client/apis/NotificationsAPI.ts:489

registerChrome

▸ registerChrome(options: RegisterChromeOptions): Promise<RegisterAmazonAndroid>

Parameters:

Name Type
options RegisterChromeOptions

Returns: Promise<RegisterAmazonAndroid>

Defined in: client/apis/NotificationsAPI.ts:502

registerFirefox

▸ registerFirefox(options: RegisterFirefoxOptions): Promise<RegisterAmazonAndroid>

Parameters:

Name Type
options RegisterFirefoxOptions

Returns: Promise<RegisterAmazonAndroid>

Defined in: client/apis/NotificationsAPI.ts:515

registerIOSNative

▸ registerIOSNative(options: RegisterIOSNativeOptions): Promise<RegisterAmazonAndroid>

Parameters:

Name Type
options RegisterIOSNativeOptions

Returns: Promise<RegisterAmazonAndroid>

Defined in: client/apis/NotificationsAPI.ts:528

request

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

Parameters:

Name Type
options BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

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

suppressStreamNotificationsPrompt

▸ suppressStreamNotificationsPrompt(): Promise<SuppressStreamNotificationsPrompt>

Returns: Promise<SuppressStreamNotificationsPrompt>

Defined in: client/apis/NotificationsAPI.ts:639

updateDestinationSetting

▸ updateDestinationSetting(options: UpdateNotificationDestinationSettingsOptions): Promise<unknown>

Parameters:

Name Type
options UpdateNotificationDestinationSettingsOptions

Returns: Promise<unknown>

Defined in: client/apis/NotificationsAPI.ts:319

updateNotificationSettings

▸ updateNotificationSettings(options: UpdateNotificationSettingsOptions): Promise<unknown>

Parameters:

Name Type
options UpdateNotificationSettingsOptions

Returns: Promise<unknown>

Defined in: client/apis/NotificationsAPI.ts:332