Class GetCommentRequest

Request to get information about a comment.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.6.0

Hierarchy

AbstractCommentRequest<GetCommentResponse>
- GetCommentRequest

Index

Constructors

constructor

new GetCommentRequest(accessToken: string, commentId: string, ...fields: CommentField[]): GetCommentRequest
The constructor.
Parameters
- accessToken: string
  
  the access token.
- commentId: string
  
  the id of the comment.
- Rest ...fields: CommentField[]
  
  the fields to retrieve from the API. If no field is specified, all are retrieved.
Returns GetCommentRequest
Overrides AbstractCommentRequest.constructor
- Defined in main/requests/comment/GetCommentRequest.ts:20

Properties

`Protected` `Optional` apiVersion

apiVersion?: ApiVersion

The API Version.

`Protected` params

params: Params

The request params.

Methods

addLimit

addLimit(limit: number): void
Adds the limit param to the request.

Deprecated
since 1.7.0, use withLimit instead.
Parameters
- limit: number
  
  the number of objects to retrieve.
Returns void
Inherited from AbstractCommentRequest.addLimit
- Defined in main/requests/AbstractRequest.ts:103

addPaging

addPaging(pageOptionToken: PageOptionToken): void
Adds a paging param to the request.

Deprecated
since 1.7.0, use withPaging instead.
Parameters
- pageOptionToken: PageOptionToken
  
  the page option token to create the param.
Returns void
Inherited from AbstractCommentRequest.addPaging
- Defined in main/requests/AbstractRequest.ts:77

addRange

addRange(since: Date, until: Date): void
Adds the range params to the request.

Deprecated
since 1.7.0, use withRange instead.
Parameters
- since: Date
  
  the since param.
- until: Date
  
  the until param.
Returns void
Inherited from AbstractCommentRequest.addRange
- Defined in main/requests/AbstractRequest.ts:91

config

config(): RequestConfig
Builds the config of the request.

Returns
the request config.

Returns RequestConfig
Inherited from AbstractCommentRequest.config
- Defined in main/requests/AbstractRequest.ts:50

execute

execute(): Promise<GetCommentResponse>
Executes the requests and returns a promise of the parsed response.

Returns
the promise of a parsed response.

Returns Promise<GetCommentResponse>
Inherited from AbstractCommentRequest.execute
- Defined in main/requests/AbstractRequest.ts:64

`Protected` method

method(): Method
Gets the method for the request.

Returns
the method for the request.

Returns Method
Inherited from AbstractCommentRequest.method
- Defined in main/requests/AbstractRequest.ts:178

`Protected` parseResponse

parseResponse(response: AxiosResponse<never>): GetCommentResponse
Parses the response into a response object.
Parameters
- response: AxiosResponse<never>
  
  the parsed response.
Returns GetCommentResponse
Overrides AbstractCommentRequest.parseResponse
- Defined in main/requests/comment/GetCommentRequest.ts:29

`Protected` url

url(): string
Gets the url for the request.

Returns
the url for the request.

Returns string
Inherited from AbstractCommentRequest.url
- Defined in main/requests/comment/AbstractCommentRequest.ts:30

withApiVersion

withApiVersion(apiVersion: undefined | ApiVersion): GetCommentRequest
Sets the API version that the request will use.

Returns
this request, for use in chain invocation.
Parameters
- apiVersion: undefined | ApiVersion
  
  the API version to use.
Returns GetCommentRequest
Inherited from AbstractCommentRequest.withApiVersion
- Defined in main/requests/AbstractRequest.ts:154

withLimit

withLimit(limit: number): GetCommentRequest
Adds the limit param to the request.

Returns
this request, for use in chain invocation.
Parameters
- limit: number
  
  the number of objects to retrieve.
Returns GetCommentRequest
Inherited from AbstractCommentRequest.withLimit
- Defined in main/requests/AbstractRequest.ts:142

withPaging

withPaging(pageOptionToken: PageOptionToken): GetCommentRequest
Adds a paging param to the request.

Returns
this request, for use in chain invocation.
Parameters
- pageOptionToken: PageOptionToken
  
  the page option token to create the param.
Returns GetCommentRequest
Inherited from AbstractCommentRequest.withPaging
- Defined in main/requests/AbstractRequest.ts:114

withRange

withRange(since: Date, until: Date): GetCommentRequest
Adds the range params to the request.

Returns
this request, for use in chain invocation.
Parameters
- since: Date
  
  the since param.
- until: Date
  
  the until param.
Returns GetCommentRequest
Inherited from AbstractCommentRequest.withRange
- Defined in main/requests/AbstractRequest.ts:129

Class GetCommentRequest

Author

Since

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

accessToken: string

commentId: string

Rest ...fields: CommentField[]

Returns GetCommentRequest

Properties

Protected Optional apiVersion

Protected params

Methods

addLimit

Deprecated

Parameters

limit: number

Returns void

addPaging

Deprecated

Parameters

pageOptionToken: PageOptionToken

Returns void

addRange

Deprecated

Parameters

since: Date

until: Date

Returns void

config

Returns

Returns RequestConfig

execute

Returns

Returns Promise<GetCommentResponse>

Protected method

Returns

Returns Method

Protected parseResponse

Parameters

response: AxiosResponse<never>

Returns GetCommentResponse

Protected url

Returns

Returns string

withApiVersion

Returns

Parameters

apiVersion: undefined | ApiVersion

Returns GetCommentRequest

withLimit

Returns

Parameters

limit: number

Returns GetCommentRequest

withPaging

Returns

Parameters

pageOptionToken: PageOptionToken

Returns GetCommentRequest

withRange

Returns

Parameters

since: Date

until: Date

Returns GetCommentRequest

Settings

Member Visibility

Theme

`Rest` ...fields: CommentField[]

`Protected` `Optional` apiVersion

`Protected` params

`Protected` method

`Protected` parseResponse

`Protected` url