ESPRMAdminCustomMessageTemplate
Defined in: src/ESPRMAdminCustomMessageTemplate.ts:11
Shell class for admin custom mobile push notification message template operations. Methods are added via prototype augmentation in methods/ESPRMAdminCustomMessageTemplate/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminCustomMessageTemplate():
ESPRMAdminCustomMessageTemplate
Returns
Section titled “Returns”ESPRMAdminCustomMessageTemplate
Methods
Section titled “Methods”createCustomMessageTemplate()
Section titled “createCustomMessageTemplate()”createCustomMessageTemplate(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCustomMessageTemplate/CreateCustomMessageTemplate.ts:22
Creates a new custom push notification message template.
Parameters
Section titled “Parameters”params
Section titled “params”CreateCustomMessageTemplateRequest
The custom message template configuration to create.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming template creation.
deleteCustomMessageTemplate()
Section titled “deleteCustomMessageTemplate()”deleteCustomMessageTemplate(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCustomMessageTemplate/DeleteCustomMessageTemplate.ts:22
Deletes a custom push notification message template.
Parameters
Section titled “Parameters”params
Section titled “params”DeleteCustomMessageTemplateParams
Parameters identifying the template to delete.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the deletion.
getCustomMessageTemplates()
Section titled “getCustomMessageTemplates()”getCustomMessageTemplates(
params?):Promise<GetCustomMessageTemplatesResponse>
Defined in: src/methods/ESPRMAdminCustomMessageTemplate/GetCustomMessageTemplates.ts:22
Retrieves custom push notification message templates for the deployment.
Parameters
Section titled “Parameters”params?
Section titled “params?”GetCustomMessageTemplatesParams
Optional filter and pagination parameters.
Returns
Section titled “Returns”Promise<GetCustomMessageTemplatesResponse>
The list of custom message templates.
updateCustomMessageTemplate()
Section titled “updateCustomMessageTemplate()”updateCustomMessageTemplate(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminCustomMessageTemplate/UpdateCustomMessageTemplate.ts:22
Updates an existing custom push notification message template.
Parameters
Section titled “Parameters”params
Section titled “params”UpdateCustomMessageTemplateRequest
The updated custom message template configuration.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response confirming the update.