You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
getChannel
Endpoint for fetching a list of channels. By default, it uses the getChannelDefaultQuery GraphQL query
Signature
export declare function getChannel(
context: SetupContext,
params?: GetChannelParams,
responseOptions?: ResponseOptions
): Promise<GetChannelResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Optional | GetChannelParams | Channel information |
responseOptions | Optional | ResponseOptions |
Returns
Channel data