createOrgNotification

Function

Send a notification to members of the requesting user's org. Operation success will be indicated by a flag on the return object. If there are any errors, they will be placed in an errors array on the return object

const authentication: IAuthenticationManager; // Typically passed into to the function
//
const options: IInviteGroupUsersOptions = {
 id: 'group_id',
 users: ['larry', 'curly', 'moe'],
 notificationChannelType: 'email',
 expiration: 20160,
 authentication
}
//
const result = await createOrgNotification(options);
//
const if_success_result_looks_like = {
 success: true
}
//
const if_failure_result_looks_like = {
 success: false,
 errors: [ArcGISRequestError]
}

Parameters

Parameter Type Default Notes
options Required ICreateOrgNotificationOptions

Returns

Property Type Notes
success boolean

Whether the operation was successful

errors Optional ArcGISRequestError[] | ArcGISRequestError

An array of request errors


Function defined in packages/arcgis-rest-portal/src/orgs/notification.ts:76