Platform Specific Methods - Register For IOS Push Notification

Registers the iOS device to receive push notifications

POST https://titleId.playfabapi.com/Client/RegisterForIOSPushNotification

Request Header

Name	Required	Type	Description
X-Authorization	True	string	This API requires a client session ticket, available from any Client Login function.

Name	Required	Type	Description
DeviceToken	True	string	Unique token generated by the Apple Push Notification service when the title registered to receive push notifications.
ConfirmationMessage		string	Message to display when confirming push notification.
SendPushNotificationConfirmation		boolean	If true, send a test push message immediately after sucessful registration. Defaults to false.

Name	Type	Description
200 OK	RegisterForIOSPushNotificationResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
RegisterForIOSPushNotificationRequest	The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://docs.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart
RegisterForIOSPushNotificationResult

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://docs.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart

Name	Type	Description
ConfirmationMessage	string	Message to display when confirming push notification.
DeviceToken	string	Unique token generated by the Apple Push Notification service when the title registered to receive push notifications.
SendPushNotificationConfirmation	boolean	If true, send a test push message immediately after sucessful registration. Defaults to false.

Name	Code
NoPushNotificationARNForTitle	1083
PushServiceError	1095