Class Notifications

Hierarchy (view full)

CrowdinApi
- Notifications

Index

Constructors

Methods

graphql sendNotificationToAuthenticatedUser sendNotificationToOrganizationMembers sendNotificationToProjectMembers withFetchAll

Constructors

constructor

new Notifications(credentials, config?): Notifications
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Notifications
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:143

Methods

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:178

sendNotificationToAuthenticatedUser

sendNotificationToAuthenticatedUser(request): Promise<void>
Parameters
- request: Notification
  request body
Returns Promise<void>
Required Scope
notification:write

See
https://developer.crowdin.com/api/v2/#operation/api.notify.post
- Defined in notifications/index.ts:9

sendNotificationToOrganizationMembers

sendNotificationToOrganizationMembers(request): Promise<void>
Parameters
- request: Notification | NotificationByUsers | NotificationByRole
  request body
Returns Promise<void>
Required Scope
notification:write

See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.notify.post
- Defined in notifications/index.ts:36

sendNotificationToProjectMembers

sendNotificationToProjectMembers(projectId, request): Promise<void>
Parameters
- projectId: number
  project identifier
- request: NotificationByUsers | ProjectNotificationByRole | NotificationByRole
  request body
Returns Promise<void>
Required Scope
project:write

See
https://developer.crowdin.com/api/v2/#operation/api.projects.notify.post
- Defined in notifications/index.ts:20

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:240