Class default

Client class for interfacing with the API

Constructors

constructor

Properties

auth chats discover flocks groups posts user videos

Methods

connect

Constructors

constructor

  • new default(cookie?, eulaAccepted?): default

  • Parameters

    • Optional cookie: string
    • Optional eulaAccepted: boolean

    Returns default

Properties

auth

auth: default

The AuthService for this Client

chats

chats: default

The ChatAPI for this Client

discover

discover: default

The DiscoverAPI for this Client

flocks

flocks: default

The FlocksAPI for this Client

groups

groups: default

The GroupsApi for this Client

posts

posts: default

The PostAPI for this Client

user

user: default

The UserAPI for this Client

videos

videos: default

The VideoAPI for this Client

Methods

connect

  • connect(): Promise<boolean>

  • Connects to the API using the information provided during the class's construction. This will accept the EULA for the User if needed.

    Returns Promise<boolean>

    A promise that resolves true if the connection was successful

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc