ICreateGroupNotificationOptions

Interface

Inheritance: ICreateGroupNotificationOptionsIUserGroupOptions

Properties

PropertyTypeNotes

A session representing a logged in user.

clientId
 optional 
string

ClientId of the application through which user receives messages on the mobile device. This only applies to push notifications.

credentials
 optional 
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
 optional 
boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod
 optional 

The HTTP method to send the request with.

string

Unique identifier of the group.

maxUrlLength
 optional 
number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

string | object

Message to be sent. For builtin and email notifications this is a string. For push notifications, this will be JSON.

The channel through which the notification is to be delivered. Supported values are push, email, or builtin. If push is chosen, a message will be delivered only to those group members that have registered their devices to receive push notifications. If the user has registered more than one device for the app, then message will be sent to all the registered devices. Email will be sent when the email option is chosen. If the builtin option is chosen, a notification will be added to the notifications list that the user can see when logged into the home app.

params
 optional 

Additional parameters to pass in the request.

portal
 optional 
string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse
 optional 
boolean

Return the raw response

signal
 optional 
AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

silentNotification
 optional 
boolean

This only applies to push notifications. When set to true, message will be delivered to the app and it will not show as an alert to the user.

subject
 optional 
string

Subject of the notification. This only applies to email and builtin notifications. For push notifications, subject/title is provided as a part of the message payload.

suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

users
 optional 
string[]

Array of usernames of the users in the group to whom the message should be sent. If not provided, the message will be sent to all users in the group if the user is an admin. Only group admins will be able to send notifications to a list of users. Group users will be able to send notifications to only one user at a time.

authentication

authentication: ArcGISIdentityManager

A session representing a logged in user.

clientId optional

clientId: string

ClientId of the application through which user receives messages on the mobile device. This only applies to push notifications.

credentials optional

credentials: RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

hideToken: boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

httpMethod optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

id

id: string

Unique identifier of the group.

maxUrlLength optional

maxUrlLength: number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

message

message: string | object

Message to be sent. For builtin and email notifications this is a string. For push notifications, this will be JSON.

notificationChannelType optional

notificationChannelType: NotificationChannelType

The channel through which the notification is to be delivered. Supported values are push, email, or builtin. If push is chosen, a message will be delivered only to those group members that have registered their devices to receive push notifications. If the user has registered more than one device for the app, then message will be sent to all the registered devices. Email will be sent when the email option is chosen. If the builtin option is chosen, a notification will be added to the notifications list that the user can see when logged into the home app.

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

portal: string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

rawResponse optional

rawResponse: boolean

Return the raw response

signal optional

signal: AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

silentNotification optional

silentNotification: boolean

This only applies to push notifications. When set to true, message will be delivered to the app and it will not show as an alert to the user.

subject optional

subject: string

Subject of the notification. This only applies to email and builtin notifications. For push notifications, subject/title is provided as a part of the message payload.

suppressWarnings optional

suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

users optional

users: string[]

Array of usernames of the users in the group to whom the message should be sent. If not provided, the message will be sent to all users in the group if the user is an admin. Only group admins will be able to send notifications to a list of users. Group users will be able to send notifications to only one user at a time.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.