Class ManyIdsResponse

Class that represents a response from a request that simply returns an array of id objects.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

1.2.0

Hierarchy

AbstractResponse<{
id: string;
}[]>
- ManyIdsResponse

Index

Constructors

Properties

Methods

getData getIds getPaging

Constructors

constructor

new ManyIdsResponse(body: {
    data: {
        id: string;
    }[];
    paging: PagingData;
}): ManyIdsResponse
The constructor.
Parameters
- body: {
      data: {
          id: string;
      }[];
      paging: PagingData;
  }
  
  the body of the response
  - data: {
    id: string;
    }[]
  - paging: PagingData
Returns ManyIdsResponse
Overrides AbstractResponse.constructor
- Defined in main/requests/common/ManyIdsResponse.ts:21

Properties

`Protected` data

data: {
id: string;
}[]

The response data.

`Private` `Readonly` paging

paging: Paging

The paging of the response.

Methods

getData

getData(): {
id: string;
}[]
Gets the response data.

Returns
the response data.

Returns {
id: string;
}[]
Inherited from AbstractResponse.getData
- Defined in main/requests/AbstractResponse.ts:29

getIds

getIds(): string[]
Gets the ids in the response.

Returns
the ids in the response.

Returns string[]
- Defined in main/requests/common/ManyIdsResponse.ts:31

getPaging

getPaging(): Paging
Gets the paging of the response.

Returns
the paging of the response.

Returns Paging
- Defined in main/requests/common/ManyIdsResponse.ts:40

Generated using TypeDoc