Beamable.Server.Api.Notifications.IMicroserviceNotificationsApi Interface Reference

Microservice API for sending Notifications to clients. More...

Public Member Functions
Promise< EmptyResponse >	NotifyPlayer (long gamertag, string name, string messagePayload)
	Notifies the player with the given gamertag at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code. More...
Promise< EmptyResponse >	NotifyPlayer (List< long > gamertags, string name, string messagePayload)
	Notifies the players identified by the given gamertags at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code. More...
Promise< EmptyResponse >	NotifyPlayer< T > (long gamertag, string name, T messagePayload)
	Notifies the player with the given gamertag at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code. More...
Promise< EmptyResponse >	NotifyPlayer< T > (List< long > gamertags, string name, T messagePayload)
	Notifies the players identified by the given gamertags at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code. More...

Detailed Description

Microservice API for sending Notifications to clients.

Member Function Documentation

NotifyPlayer() [1/2]

Promise< EmptyResponse > Beamable.Server.Api.Notifications.IMicroserviceNotificationsApi.NotifyPlayer	(	List< long >	gamertags,
		string	name,
		string	messagePayload
	)

Notifies the players identified by the given gamertags at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code.

Parameters

gamertags	The list of gamertags for the players you wish to notify.
name	The context that player's client must be subscribed too to see the notification.
messagePayload	The non-JSON string data to send along with the notification. Due to Beamable constraints, note that the string message will be sent with an outer "stringValue" field wrapping it.

NotifyPlayer() [2/2]

Promise< EmptyResponse > Beamable.Server.Api.Notifications.IMicroserviceNotificationsApi.NotifyPlayer	(	long	gamertag,
		string	name,
		string	messagePayload
	)

Notifies the player with the given gamertag at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code.

Parameters

gamertag	The gamertag for the player you wish to notify.
name	The context that player's client must be subscribed too to see the notification.
messagePayload	The non-JSON string data to send along with the notification. Due to Beamable constraints, note that the string message will be sent with an outer "stringValue" field wrapping it.

NotifyPlayer< T >() [1/2]

Promise< EmptyResponse > Beamable.Server.Api.Notifications.IMicroserviceNotificationsApi.NotifyPlayer< T >	(	List< long >	gamertags,
		string	name,
		T	messagePayload
	)

Notifies the players identified by the given gamertags at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code.

Parameters

gamertags	The list of gamertags for the players you wish to notify.
name	The context that player's client must be subscribed too to see the notification.
messagePayload	The data to send along with the notification. Must be a JSON-serializable type.

NotifyPlayer< T >() [2/2]

Promise< EmptyResponse > Beamable.Server.Api.Notifications.IMicroserviceNotificationsApi.NotifyPlayer< T >	(	long	gamertag,
		string	name,
		T	messagePayload
	)

Notifies the player with the given gamertag at the given name . The name is the one you should subscribe to in your INotificationService.Subscribe<T> calls in the client-code.

Parameters

gamertag	The gamertag for the player you wish to notify.
name	The context that player's client must be subscribed too to see the notification.
messagePayload	The data to send along with the notification. Must be a JSON-serializable type.

---

The documentation for this interface was generated from the following file:

• com.beamable.server/SharedRuntime/Api/Notifications/IMicroserviceNotificationsApi.cs