Class PostHideCommentRequest

Request to toggle whether a comment is hidden.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.6.0

Hierarchy

AbstractCommentRequest<CommentUpdateResponse>
- PostHideCommentRequest

Index

Constructors

Properties

apiVersion? params

Methods

addLimit addPaging addRange config execute method parseResponse url withApiVersion withLimit withPaging withRange

Constructors

constructor

new PostHideCommentRequest(accessToken: string, commentId: string, hide?: boolean): PostHideCommentRequest
The constructor.
Parameters
- accessToken: string
  
  the access token.
- commentId: string
  
  the id of the comment.
- hide: boolean = true
  
  whether to hide or show the comment (default: true).
Returns PostHideCommentRequest
Overrides AbstractCommentRequest.constructor
- Defined in main/requests/comment/PostHideCommentRequest.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<CommentUpdateResponse>
Executes the requests and returns a promise of the parsed response.

Returns
the promise of a parsed response.

Returns Promise<CommentUpdateResponse>
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
Overrides AbstractCommentRequest.method
- Defined in main/requests/comment/PostHideCommentRequest.ts:35

`Protected` parseResponse

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

`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): PostHideCommentRequest
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 PostHideCommentRequest
Inherited from AbstractCommentRequest.withApiVersion
- Defined in main/requests/AbstractRequest.ts:154

withLimit

withLimit(limit: number): PostHideCommentRequest
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 PostHideCommentRequest
Inherited from AbstractCommentRequest.withLimit
- Defined in main/requests/AbstractRequest.ts:142

withPaging

withPaging(pageOptionToken: PageOptionToken): PostHideCommentRequest
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 PostHideCommentRequest
Inherited from AbstractCommentRequest.withPaging
- Defined in main/requests/AbstractRequest.ts:114

withRange

withRange(since: Date, until: Date): PostHideCommentRequest
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 PostHideCommentRequest
Inherited from AbstractCommentRequest.withRange
- Defined in main/requests/AbstractRequest.ts:129

Generated using TypeDoc