Class SpaceService

Handles interacting with resources related to spaces.

Hierarchy (View Summary)

Constructors

constructor

Properties

config

Methods

details request

Constructors

constructor

Properties

Protected Readonlyconfig

config: RettiwtConfig

The config object.

Methods

details

  • details(id: string, options?: ISpaceDetailsOptions): Promise<undefined | Space>

    Get the details of a space.

    Parameters

    • id: string

      The ID of the target space.

    • Optionaloptions: ISpaceDetailsOptions

      Additional options for the fetch.

    Returns Promise<undefined | Space>

    The details of the space with the given ID.

    Example

    import { Rettiwt } from 'rettiwt-api';

    const rettiwt = new Rettiwt({ apiKey: API_KEY });

    rettiwt.space.details('1YqJDNEzvoVKV', { withListeners: true })
    .then(res => {
    	console.log(res);
    })
    .catch(err => {
    	console.log(err);
    });

request

  • request<T = unknown>(
        resource: ResourceType,
        args: IFetchArgs | IPostArgs,
    ): Promise<AxiosResponse<T, any, {}>>

    Makes an HTTP request according to the given parameters.

    Type Parameters

    • T = unknown

      The type of the returned response data.

    Parameters

    Returns Promise<AxiosResponse<T, any, {}>>

    The raw Axios response.

    Example

    Fetching the raw details of a single user, using their username

    import { FetcherService, ResourceType } from 'rettiwt-api';

    // Creating a new FetcherService instance using the given 'API_KEY'
    const fetcher = new FetcherService({ apiKey: API_KEY });

    // Fetching the details of the User with username 'user1'
    fetcher.request(ResourceType.USER_DETAILS_BY_USERNAME, { id: 'user1' })
    .then(res => {
    	console.log(res);
    })
    .catch(err => {
    	console.log(err);
    });

Settings

Member Visibility

On This Page

Constructors
Properties
Methods