Class NotificationSettings

Hierarchy

UrlSection
- NotificationSettings

Index

Constructors

constructor

Methods

Constructors

constructor

new NotificationSettings(prv: PathSegment, id?: string, service?: any): NotificationSettings

Overrides UrlSection.constructor
- Defined in paths/NotificationSettings.ts:6
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns NotificationSettings

Methods

get

get(): Promise<INotificationSettings>

- Defined in paths/NotificationSettings.ts:14
Since 1.0.26 (Release 8.2)
Returns notification settings for the current extension.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
Usage Plan Group
Light

Returns Promise<INotificationSettings>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

put

put(body: NotificationSettingsUpdateRequest): Promise<INotificationSettings>

- Defined in paths/NotificationSettings.ts:27
Since 1.0.26 (Release 8.2)
Updates notification settings for the current extension.
Required Permissions
Permission Description
EditExtensions Viewing and updating my extension info (includes extension name, number, email and phone number)
Usage Plan Group
Medium

Parameters
- body: NotificationSettingsUpdateRequest
Returns Promise<INotificationSettings>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc