GuideGetChannelParams 1.0.0 API

All Implemented Interfaces:

app.knock.api.core.Params
```
public final class GuideGetChannelParams
 implements Params
                    
```
Returns a list of eligible in-app guides for a specific user and channel.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`GuideGetChannelParams.Builder`	A builder for GuideGetChannelParams.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`userId()`
`final Optional<String>`	`channelId()`
`final Optional<String>`	`data()`	The data (JSON encoded object) to use for targeting and rendering guides.
`final Optional<String>`	`tenant()`	The tenant ID to use for targeting and rendering guides.
`final Optional<String>`	`type()`	The type of guides to filter by.
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final GuideGetChannelParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static GuideGetChannelParams`	`none()`
`final static GuideGetChannelParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of GuideGetChannelParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - userId
```
 final Optional<String> userId()
```
  - channelId
```
 final Optional<String> channelId()
```
  - data
```
 final Optional<String> data()
```
    The data (JSON encoded object) to use for targeting and rendering guides.
  - tenant
```
 final Optional<String> tenant()
```
    The tenant ID to use for targeting and rendering guides.
  - type
```
 final Optional<String> type()
```
    The type of guides to filter by.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final GuideGetChannelParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static GuideGetChannelParams none()
```
  - builder
```
 final static GuideGetChannelParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of GuideGetChannelParams.