Class HubObjectQueryResponse

Represents the response to a HubObjectQueryRequest.

Hierarchy

HubObjectQueryResponse

Index

Constructors

constructor

Properties

response

Methods

Constructors

constructor

new HubObjectQueryResponse(json: IHubObjectQueryResponse): HubObjectQueryResponse

- Defined in responses/HubObjectQueryResponse.ts:8
Parameters
- json: IHubObjectQueryResponse
Returns HubObjectQueryResponse

Properties

Private response

response: IHubObjectQueryResponse

Methods

getObjects

getObjects(): IObjectMetadata[]

- Defined in responses/HubObjectQueryResponse.ts:23
Returns the set of objects returned by the Hub.

TODO: Map JSON into useful objects, as done for commits.

Returns IObjectMetadata[]

getSkipToken

getSkipToken(): null | string

- Defined in responses/HubObjectQueryResponse.ts:37
Retrieves a token which can be used to fetch subsequent result pages.

Returns null | string

hasSkipToken

hasSkipToken(): boolean

- Defined in responses/HubObjectQueryResponse.ts:30
Indicates whether additional pages of results are available.

Returns boolean

Generated using TypeDoc