PlayerIO

The fastest way to build online games without breaking a sweat.

Multiplayer Reference

Multiplayer class documentationClass Notifications

Namespace: PlayerIO.GameLibrary
Language: C# / .NET

The Player.IO Notifications service

Properties

 
public NotificationEndpoint[]
MyEndpoints  [read-only]

The list of notification endpoints registered for the current client.

Methods

 
public void
DeleteEndpoints (NotificationEndpoint[] endpoints, Callback successCallback)

Deletes the given endpoints
public void
DeleteEndpoints (NotificationEndpoint[] endpoints, Callback successCallback, Callback<PlayerIOError> errorCallback)

Deletes the given endpoints
public void
Refresh (Callback successCallback)

Refreshes MyEndpoints
public void
Refresh (Callback successCallback, Callback<PlayerIOError> errorCallback)

Refreshes MyEndpoints
public void
RegisterEndpoint (string endpointType, string identifier, Dictionary<string, string> configuration, bool enabled, Callback successCallback)

Register a device or endpoint with Player.IO.
public void
RegisterEndpoint (string endpointType, string identifier, Dictionary<string, string> configuration, bool enabled, Callback successCallback, Callback<PlayerIOError> errorCallback)

Register a device or endpoint with Player.IO.
public void
Send (Notification[] notifications, Callback successCallback, Callback<PlayerIOError> errorCallback)

Send one or more notifications
public void
Send (Notification[] notifications, Callback successCallback)

Send one or more notifications
public void
ToggleEndpoints (NotificationEndpoint[] endpoints, bool enable, Callback successCallback, Callback<PlayerIOError> errorCallback)

Enables or disabled the given endpoints.
public void
ToggleEndpoints (NotificationEndpoint[] endpoints, bool enable, Callback successCallback)

Enables or disabled the given endpoints.

Notifications.MyEndpoints

public NotificationEndpoint[]
MyEndpoints  [read-only]

The list of notification endpoints registered for the current client.

Notifications.DeleteEndpoints

public void
DeleteEndpoints (NotificationEndpoint[] endpoints, Callback successCallback)

Deletes the given endpoints

Arguments

NotificationEndpoint[] endpoints
The endpoints to delete.
Callback successCallback
Callback that is invoked when operation succeeds

Notifications.DeleteEndpoints

public void
DeleteEndpoints (NotificationEndpoint[] endpoints, Callback successCallback, Callback<PlayerIOError> errorCallback)

Deletes the given endpoints

Arguments

NotificationEndpoint[] endpoints
The endpoints to delete.
Callback successCallback
Callback that is invoked when operation succeeds
Callback<PlayerIOError> errorCallback
Callback that is invoked when operation fails

Notifications.Refresh

public void
Refresh (Callback successCallback)

Refreshes MyEndpoints

Arguments

Callback successCallback
Callback that will be called when the refresh is complete.

Notifications.Refresh

public void
Refresh (Callback successCallback, Callback<PlayerIOError> errorCallback)

Refreshes MyEndpoints

Arguments

Callback successCallback
Callback that will be called when the refresh is complete.
Callback<PlayerIOError> errorCallback
Callback that will be called instead of successCallback if an error occurs.

Notifications.RegisterEndpoint

public void
RegisterEndpoint (string endpointType, string identifier, Dictionary<string, string> configuration, bool enabled, Callback successCallback)

Register a device or endpoint with Player.IO.

Arguments

string endpointType
Endpoint type, such as, IOS, Android, email, etc.
string identifier
The identifier of the endpoint, such as the device token on iOS or an email address for email.
Dictionary<string, string> configuration
Configuration relating to the endpoint. Can be null.
bool enabled
Should the endpoint be enabled.
Callback successCallback
Callback that is invoked when operation succeeds

Notifications.RegisterEndpoint

public void
RegisterEndpoint (string endpointType, string identifier, Dictionary<string, string> configuration, bool enabled, Callback successCallback, Callback<PlayerIOError> errorCallback)

Register a device or endpoint with Player.IO.

Arguments

string endpointType
Endpoint type, such as, IOS, Android, email, etc.
string identifier
The identifier of the endpoint, such as the device token on iOS or an email address for email.
Dictionary<string, string> configuration
Configuration relating to the endpoint. Can be null.
bool enabled
Should the endpoint be enabled.
Callback successCallback
Callback that is invoked when operation succeeds
Callback<PlayerIOError> errorCallback
Callback that is invoked when operation fails

Notifications.Send

public void
Send (Notification[] notifications, Callback successCallback, Callback<PlayerIOError> errorCallback)

Send one or more notifications

Arguments

Notification[] notifications
The notifications to send
Callback successCallback
Callback that is invoked when operation succeeds
Callback<PlayerIOError> errorCallback
Callback that is invoked when operation fails

Notifications.Send

public void
Send (Notification[] notifications, Callback successCallback)

Send one or more notifications

Arguments

Notification[] notifications
The notifications to send
Callback successCallback
Callback that is invoked when operation succeeds

Notifications.ToggleEndpoints

public void
ToggleEndpoints (NotificationEndpoint[] endpoints, bool enable, Callback successCallback, Callback<PlayerIOError> errorCallback)

Enables or disabled the given endpoints.

Arguments

NotificationEndpoint[] endpoints
The endpoints to enable or disable.
bool enable
If true, all the given endpoints will be enabled. If false, they'll be disabled.
Callback successCallback
Callback that is invoked when operation succeeds
Callback<PlayerIOError> errorCallback
Callback that is invoked when operation fails

Notifications.ToggleEndpoints

public void
ToggleEndpoints (NotificationEndpoint[] endpoints, bool enable, Callback successCallback)

Enables or disabled the given endpoints.

Arguments

NotificationEndpoint[] endpoints
The endpoints to enable or disable.
bool enable
If true, all the given endpoints will be enabled. If false, they'll be disabled.
Callback successCallback
Callback that is invoked when operation succeeds