Skip to content

Module: client/apis/NotificationsAPI

Table of contents

Classes

Type aliases

Type aliases

AllowNotificationSource

Ƭ AllowNotificationSource: unknown

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

AllowNotificationSourceOptions

Ƭ AllowNotificationSourceOptions: object

Type declaration:

Name Type
sourceType string

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

AllowNotificationsDestination

Ƭ AllowNotificationsDestination: unknown

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

AllowNotificationsDestinationOptions

Ƭ AllowNotificationsDestinationOptions: object

Type declaration:

Name Type
destinationType string

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

ClearUnreadStreamNotifications

Ƭ ClearUnreadStreamNotifications: object

Type declaration:

Name Type
statusMessage string

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

DeregisterAllDevices

Ƭ DeregisterAllDevices: object

Type declaration:

Name Type
statusMessage string

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

DeregisterCurrentDevice

Ƭ DeregisterCurrentDevice: object

Type declaration:

Name Type
statusMessage string

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

DisallowNotificationSource

Ƭ DisallowNotificationSource: unknown

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

DisallowNotificationSourceOptions

Ƭ DisallowNotificationSourceOptions: AllowNotificationSourceOptions

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

DisallowNotificationsDestination

Ƭ DisallowNotificationsDestination: unknown

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

DisallowNotificationsDestinationOptions

Ƭ DisallowNotificationsDestinationOptions: AllowNotificationsDestinationOptions

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

GetChromeNotificationsManifest

Ƭ GetChromeNotificationsManifest: object

Type declaration:

Name Type
gcm_sender_id string
name string

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

GetCurrentNotificationDeviceDestination

Ƭ GetCurrentNotificationDeviceDestination: object

Type declaration:

Name Type
destination object
destination.application string
destination.name string
destination.notificationToken string
destination.platform string
destination.supportsUpdateNotifications boolean
destination.user object
destination.user.name string
destination.user.userId number
destination.userPushNotificationDestinationId number
statusMessage string

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

GetLatestUniverseUpdates

Ƭ GetLatestUniverseUpdates: { content: string ; createdOn: string ; createdOnKey: string ; rootPlaceId: number ; universeId: number ; universeName: string }[]

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

GetLatestUniversesUpdatesOptions

Ƭ GetLatestUniversesUpdatesOptions: object

Type declaration:

Name Type
sinceDateTime? string
universeIds number[]

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

GetNotificationDestinations

Ƭ GetNotificationDestinations: object

Type declaration:

Name Type
destinations GetCurrentNotificationDeviceDestination[destination][]
statusMessage string

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

GetNotificationIds

Ƭ GetNotificationIds: object

Type declaration:

Name Type
ids string[]
statusMessage string

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

GetNotificationIdsOptions

Ƭ GetNotificationIdsOptions: object

Type declaration:

Name Type
cursor? string
limit number
notificationToken string

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

GetNotificationsMetaData

Ƭ GetNotificationsMetaData: object

Type declaration:

Name Type
metadata object
metadata.detail unknown
metadata.fallbackDelivered boolean
metadata.notificationId string
metadata.type string
statusMessage string

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

GetNotificationsMetaDataOptions

Ƭ GetNotificationsMetaDataOptions: object

Type declaration:

Name Type
notificationId number
notificationToken string

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

GetNotificationsSettings

Ƭ GetNotificationsSettings: object

Type declaration:

Name Type
notificationBandSettings { isEnabled: boolean ; isOverridable: boolean ; isSetByReceiver: boolean ; notificationSourceType: string ; pushNotificationDestinationPreferences: [{ destinationId: 0 ; isEnabled: boolean ; isSetByReceiver: boolean ; name: string ; platform: string }] ; receiverDestinationType: string }[]
optedOutNotificationSourceTypes string[]
optedOutReceiverDestinationTypes string[]

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

GetRealtimeNotificationsSettings

Ƭ GetRealtimeNotificationsSettings: object

Type declaration:

Name Type
fallbackDomain string
primaryDomain string

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

GetRecentStreamNotifications

Ƭ GetRecentStreamNotifications: { eventCount: number ; eventDate: string ; id: number ; isInteracted: boolean ; metadataCollection: unknown[] ; notificationSourceType: string }[]

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

GetRecentStreamNotificationsOptions

Ƭ GetRecentStreamNotificationsOptions: object

Type declaration:

Name Type
maxRows? number
startIndex? number

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

GetStreamNotificationsMetaData

Ƭ GetStreamNotificationsMetaData: object

Type declaration:

Name Type
bannerDismissTimeSpan number
canLaunchGameFromGameUpdate boolean
signalRDisconnectionResponseInMilliseconds number
useFriendsApiForAjaxRequests boolean

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

GetStreamNotificationsPromptSettings

Ƭ GetStreamNotificationsPromptSettings: object

Type declaration:

Name Type
hasUserInteractedWithNotificationsStream boolean
showNotificationStreamPrompt boolean

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

GetStreamNotificationsUnreadCount

Ƭ GetStreamNotificationsUnreadCount: object

Type declaration:

Name Type
statusMessage string
unreadNotifications number

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

MarkNotificationCategoryRead

Ƭ MarkNotificationCategoryRead: object

Type declaration:

Name Type
statusMessage string

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

MarkNotificationCategoryReadOptions

Ƭ MarkNotificationCategoryReadOptions: object

Type declaration:

Name Type
category string
latestNotificationId string
notificationType string

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

MarkNotificationInteraction

Ƭ MarkNotificationInteraction: object

Type declaration:

Name Type
statusMessage string

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

MarkNotificationInteractionOptions

Ƭ MarkNotificationInteractionOptions: object

Type declaration:

Name Type
interactionType string
notificationId number
notificationToken string
platformType string

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

MarkNotificationRead

Ƭ MarkNotificationRead: object

Type declaration:

Name Type
statusMessage string

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

MarkNotificationReadOptions

Ƭ MarkNotificationReadOptions: object

Type declaration:

Name Type
notificationId string
platformType string

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

MarkStreamNotificationInteracted

Ƭ MarkStreamNotificationInteracted: object

Type declaration:

Name Type
statusMessage string

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

MarkStreamNotificationInteractedOptions

Ƭ MarkStreamNotificationInteractedOptions: object

Type declaration:

Name Type
eventId string

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

RegisterAmazonAndroid

Ƭ RegisterAmazonAndroid: object

Type declaration:

Name Type
registration object
registration.application string
registration.name string
registration.notificationToken string
registration.platform string
registration.userPushNotificationDestinationId number
statusMessage string

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

RegisterAmazonAndroidOptions

Ƭ RegisterAmazonAndroidOptions: object

Type declaration:

Name Type
authorizeForUser boolean
deviceName string
notificationToken string
oldNotificationToken string

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

RegisterAndroidNative

Ƭ RegisterAndroidNative: RegisterAmazonAndroid

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

RegisterAndroidNativeOptions

Ƭ RegisterAndroidNativeOptions: RegisterAmazonAndroidOptions

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

RegisterAndroidTencentService

Ƭ RegisterAndroidTencentService: RegisterAmazonAndroid

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

RegisterAndroidTencentServiceOptions

Ƭ RegisterAndroidTencentServiceOptions: RegisterAmazonAndroidOptions

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

RegisterChrome

Ƭ RegisterChrome: RegisterAmazonAndroid

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

RegisterChromeOptions

Ƭ RegisterChromeOptions: object

Type declaration:

Name Type
initiatedByUser boolean
notificationToken string

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

RegisterFirefox

Ƭ RegisterFirefox: RegisterAmazonAndroid

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

RegisterFirefoxOptions

Ƭ RegisterFirefoxOptions: RegisterChromeOptions & { notificationEndpoint: string }

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

RegisterIOSNative

Ƭ RegisterIOSNative: RegisterAmazonAndroid

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

RegisterIOSNativeOptions

Ƭ RegisterIOSNativeOptions: object

Type declaration:

Name Type
authorizeForUser boolean
destinationIdentifier string
deviceName string
notificationToken string
oldNotificationToken string

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

SendGameUpdateNotificationInteracted

Ƭ SendGameUpdateNotificationInteracted: object

Type declaration:

Name Type
statusMessage string

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

SendGameUpdateNotificationInteractedOptions

Ƭ SendGameUpdateNotificationInteractedOptions: object

Type declaration:

Name Type
createdOnKey string
currentUserId number
interactioNType string
universeId number

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

SendGameUpdateNotificationRead

Ƭ SendGameUpdateNotificationRead: object

Type declaration:

Name Type
statusMessage string

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

SendGameUpdateNotificationReadOptions

Ƭ SendGameUpdateNotificationReadOptions: object

Type declaration:

Name Type
createdOn string
currentUserId number
universeId number

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

SuppressStreamNotificationsPrompt

Ƭ SuppressStreamNotificationsPrompt: object

Type declaration:

Name Type
statusMessage string

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

UpdateNotificationDestinationSettings

Ƭ UpdateNotificationDestinationSettings: unknown

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

UpdateNotificationDestinationSettingsOptions

Ƭ UpdateNotificationDestinationSettingsOptions: object

Type declaration:

Name Type
destinationId number
isEnabled boolean
notificationSourceType string

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

UpdateNotificationSettings

Ƭ UpdateNotificationSettings: unknown

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

UpdateNotificationSettingsOptions

Ƭ UpdateNotificationSettingsOptions: object

Type declaration:

Name Type
updatedSettings { isEnabled: boolean ; notificationSourceType: string ; receiverDestination: string }[]

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