Class IssueNotificationSchemes

Index

Constructors

Methods

addNotifications createNotificationScheme deleteNotificationScheme getNotificationScheme getNotificationSchemes getNotificationSchemeToProjectMappings removeNotificationFromNotificationScheme updateNotificationScheme

Constructors

constructor

new IssueNotificationSchemes(client: Client): Version3.IssueNotificationSchemes
Parameters
- client: Client
Returns Version3.IssueNotificationSchemes
- Defined in src/version3/issueNotificationSchemes.ts:8

Methods

addNotifications

addNotifications<T = void>(
parameters: Version3Parameters.AddNotifications,
callback: Callback<T>,
): Promise<void>
Adds notifications to a notification scheme. You can add up to 1000 notifications per request.

Deprecated: The notification type EmailAddress is no longer supported in Cloud. Refer to the changelog for more details.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddNotifications
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:227
addNotifications<T = void>(
parameters: Version3Parameters.AddNotifications,
callback?: undefined,
): Promise<T>
Adds notifications to a notification scheme. You can add up to 1000 notifications per request.

Deprecated: The notification type EmailAddress is no longer supported in Cloud. Refer to the changelog for more details.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddNotifications
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:237

createNotificationScheme

createNotificationScheme<T = Version3Models.NotificationSchemeId>(
parameters: Version3Parameters.CreateNotificationScheme,
callback: Callback<T>,
): Promise<void>
Creates a notification scheme with notifications. You can create up to 1000 notifications per request.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.NotificationSchemeId
Parameters
- parameters: Version3Parameters.CreateNotificationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:64
createNotificationScheme<T = Version3Models.NotificationSchemeId>(
parameters: Version3Parameters.CreateNotificationScheme,
callback?: undefined,
): Promise<T>
Creates a notification scheme with notifications. You can create up to 1000 notifications per request.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.NotificationSchemeId
Parameters
- parameters: Version3Parameters.CreateNotificationScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:74

deleteNotificationScheme

deleteNotificationScheme<T = void>(
parameters: Version3Parameters.DeleteNotificationScheme,
callback: Callback<T>,
): Promise<void>
Deletes a notification scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteNotificationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:256
deleteNotificationScheme<T = void>(
parameters: Version3Parameters.DeleteNotificationScheme,
callback?: undefined,
): Promise<T>
Deletes a notification scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteNotificationScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:266

getNotificationScheme

getNotificationScheme<T = Version3Models.NotificationScheme>(
parameters: string | Version3Parameters.GetNotificationScheme,
callback: Callback<T>,
): Promise<void>
Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.
Type Parameters
- T = Version3Models.NotificationScheme
Parameters
- parameters: string | Version3Parameters.GetNotificationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:149
getNotificationScheme<T = Version3Models.NotificationScheme>(
parameters: string | Version3Parameters.GetNotificationScheme,
callback?: undefined,
): Promise<T>
Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.

Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with the notification scheme.
Type Parameters
- T = Version3Models.NotificationScheme
Parameters
- parameters: string | Version3Parameters.GetNotificationScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:161

getNotificationSchemes

getNotificationSchemes<T = Version3Models.PageNotificationScheme>(
parameters: undefined | Version3Parameters.GetNotificationSchemes,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of notification schemes ordered by the display name.

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.
Type Parameters
- T = Version3Models.PageNotificationScheme
Parameters
- parameters: undefined | Version3Parameters.GetNotificationSchemes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:20
getNotificationSchemes<T = Version3Models.PageNotificationScheme>(
parameters?: Version3Parameters.GetNotificationSchemes,
callback?: undefined,
): Promise<T>
Returns a paginated list of notification schemes ordered by the display name.

Note that you should allow for events without recipients to appear in responses.

Permissions required: Permission to access Jira, however, the user must have permission to administer at least one project associated with a notification scheme for it to be returned.
Type Parameters
- T = Version3Models.PageNotificationScheme
Parameters
- Optionalparameters: Version3Parameters.GetNotificationSchemes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:34

getNotificationSchemeToProjectMappings

getNotificationSchemeToProjectMappings<
    T = Version3Models.NotificationSchemeAndProjectMappingPage,
>(
    parameters:
        | undefined
        | Version3Parameters.GetNotificationSchemeToProjectMappings,
    callback: Callback<T>,
): Promise<void>
Returns a paginated mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.NotificationSchemeAndProjectMappingPage
Parameters
- parameters: undefined | Version3Parameters.GetNotificationSchemeToProjectMappings
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:105
getNotificationSchemeToProjectMappings<
    T = Version3Models.NotificationSchemeAndProjectMappingPage,
>(
    parameters?: Version3Parameters.GetNotificationSchemeToProjectMappings,
    callback?: undefined,
): Promise<T>
Returns a paginated mapping of project that have notification scheme assigned. You can provide either one or multiple notification scheme IDs or project IDs to filter by. If you don't provide any, this will return a list of all mappings. Note that only company-managed (classic) projects are supported. This is because team-managed projects don't have a concept of a default notification scheme. The mappings are ordered by projectId.

Permissions required: Permission to access Jira.
Type Parameters
- T = Version3Models.NotificationSchemeAndProjectMappingPage
Parameters
- Optionalparameters: Version3Parameters.GetNotificationSchemeToProjectMappings
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:119

removeNotificationFromNotificationScheme

removeNotificationFromNotificationScheme<T = void>(
parameters: Version3Parameters.RemoveNotificationFromNotificationScheme,
callback: Callback<T>,
): Promise<void>
Removes a notification from a notification scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveNotificationFromNotificationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:288
removeNotificationFromNotificationScheme<T = void>(
parameters: Version3Parameters.RemoveNotificationFromNotificationScheme,
callback?: undefined,
): Promise<T>
Removes a notification from a notification scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveNotificationFromNotificationScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:298

updateNotificationScheme

updateNotificationScheme<T = void>(
parameters: Version3Parameters.UpdateNotificationScheme,
callback: Callback<T>,
): Promise<void>
Updates a notification scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateNotificationScheme
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueNotificationSchemes.ts:188
updateNotificationScheme<T = void>(
parameters: Version3Parameters.UpdateNotificationScheme,
callback?: undefined,
): Promise<T>
Updates a notification scheme.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateNotificationScheme
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueNotificationSchemes.ts:198

Class IssueNotificationSchemes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueNotificationSchemes

Methods

addNotifications

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createNotificationScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteNotificationScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getNotificationScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getNotificationSchemes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getNotificationSchemeToProjectMappings

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeNotificationFromNotificationScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateNotificationScheme

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page