Class Subscription

Hierarchy

UrlSection
- Subscription

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

delete

delete(): Promise<void>

- Defined in paths/Subscription.ts:70
Cancels the existent subscription.
Usage Plan Group
Medium

Returns Promise<void>

get

get(): Promise<SubscriptionInfo>

- Defined in paths/Subscription.ts:44
Since 1.0.6 (Release 5.15)
Returns the requested subscription.
Usage Plan Group
Light

Returns Promise<SubscriptionInfo>

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

list

list(): Promise<RecordsCollectionResourceSubscriptionResponse>

- Defined in paths/Subscription.ts:18
Returns Promise<RecordsCollectionResourceSubscriptionResponse>

post

post(body: CreateSubscriptionRequest): Promise<SubscriptionInfo>

- Defined in paths/Subscription.ts:31
Since 1.0.6 (Release 5.15)
Creates a new subscription.
Usage Plan Group
Medium

Parameters
- body: CreateSubscriptionRequest
Returns Promise<SubscriptionInfo>

put

put(body: ModifySubscriptionRequest, query?: PutQuery): Promise<SubscriptionInfo>

- Defined in paths/Subscription.ts:57
Since 1.0.6 (Release 5.15)
Renews the existent subscription if the request body is empty. If event filters are specified, calling this method modifies the event filters for the existing subscription. The client application can extend or narrow the events for which it receives notifications in the frame of one subscription.
Usage Plan Group
Medium

Parameters
- body: ModifySubscriptionRequest
- Optional query: PutQuery
Returns Promise<SubscriptionInfo>

renew

renew(id?: string): Renew

- Defined in paths/Subscription.ts:14
Parameters
- Optional id: string
Returns Renew

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