ESPRMAdminMobilePlatform
Defined in: src/ESPRMAdminMobilePlatform.ts:11
Shell class for admin mobile platform application operations. Methods are added via prototype augmentation in methods/ESPRMAdminMobilePlatform/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminMobilePlatform():
ESPRMAdminMobilePlatform
Returns
Section titled “Returns”ESPRMAdminMobilePlatform
Methods
Section titled “Methods”createMobilePlatform()
Section titled “createMobilePlatform()”createMobilePlatform(
params):Promise<CreateMobilePlatformResponse>
Defined in: src/methods/ESPRMAdminMobilePlatform/CreateMobilePlatform.ts:22
Registers a new mobile platform application for push notifications.
Parameters
Section titled “Parameters”params
Section titled “params”The mobile platform configuration to create.
Returns
Section titled “Returns”Promise<CreateMobilePlatformResponse>
The created mobile platform details including its identifier.
deleteMobilePlatform()
Section titled “deleteMobilePlatform()”deleteMobilePlatform(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminMobilePlatform/DeleteMobilePlatform.ts:27
Deletes a registered mobile platform application.
Parameters
Section titled “Parameters”params
Section titled “params”Parameters identifying the mobile platform to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the deletion.
getMobilePlatforms()
Section titled “getMobilePlatforms()”getMobilePlatforms():
Promise<GetMobilePlatformsResponse>
Defined in: src/methods/ESPRMAdminMobilePlatform/GetMobilePlatforms.ts:20
Retrieves all registered mobile platform applications for the deployment.
Returns
Section titled “Returns”Promise<GetMobilePlatformsResponse>
The list of mobile platform configurations.
updateMobilePlatform()
Section titled “updateMobilePlatform()”updateMobilePlatform(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminMobilePlatform/UpdateMobilePlatform.ts:22
Updates an existing mobile platform application configuration.
Parameters
Section titled “Parameters”params
Section titled “params”The updated mobile platform configuration.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.