The Mobile Platform App Endpoint Registartion Request.An instance of this type is used to register a specific installation of the mobile app on a device.
This is how a mobile platform app requests access to the system.
MobilePlatformAppEndpointRegisterRequest
Field | Type | Inherited from | Description |
---|---|---|---|
AmazonResourceName | String | MobilePlatformAppEndpointRegisterRequest | The Amazon Resource Name (ARN) for this particular deviceAn appliation device token may change over time. Always register the device, and supply the the ARN to have the device token updated. |
DeviceName | String | MobilePlatformAppEndpointRegisterRequest | The Device name (as supplied by the mobile platform, if available) |
DeviceToken | String | MobilePlatformAppEndpointRegisterRequest | The unique device token supplied by the mobile platform when the appliation registers with the platform to receive push notifications |
IsSandboxed | Boolean | MobilePlatformAppEndpointRegisterRequest | If the appliation is running in Developer mode, register the app as Sandboxed |
MobileAppKey | String | MobilePlatformAppEndpointRegisterRequest | The ApiKey value of the Mobile App |
Platform | String | MobilePlatformAppEndpointRegisterRequest | The Platform identifier for the specific implementation of the mobile app on the platform |
{
"AmazonResourceName" : "String",
"DeviceName" : "String",
"DeviceToken" : "String",
"IsSandboxed" : "Boolean",
"MobileAppKey" : "String",
"Platform" : "String"
}
Example in C#
// Returns: String
var item = await client.RegisterMobileAppEndpoint(FolderInfo folder, item request);
Example in CURL
curl -X POST \
https://api.us.acresecurity.cloud/api/f/INSTANCE.KEY/mobileplatformappendpoint \
-H 'Authorization: Bearer TOKEN_GOES_HERE' \
-H 'Content-Type: application/json' \
-d '{
"$type":"Feenics.Keep.WebApi.Model.MobilePlatformAppEndpointRegisterRequest, Feenics.Keep.WebApi.Model",
"MobileAppKey":MOBILEAPP.KEY,
"Platform":PLATFORM_IDENTIFIER,
"IsSandboxed":false,
"DeviceName":DEVICE_NAME,
"DeviceToken":DEVICE_TOKEN,
"AmazonResourceName":"ExampleEndpointArnFor_cUrl"
}'