Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Client

The Twitarr client. This is the primary interface to Twitarr servers.

Hierarchy

  • Client

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Construct a new Twitarr client.

    constructor

    Parameters

    • Optional httpImpl: ITwitarrHTTP

      The TwitarrHTTP implementation to use. Normally this will automatically choose the best implementation based on the environment.

    Returns Client

Properties

http

http: ITwitarrHTTP

the TwitarrHTTP implementation that will be used when making requests

server

server: TwitarrServer

The remote server to connect to

Static Private defaultHttp

defaultHttp: ITwitarrHTTP

The default TwitarrHTTP implementation to be used when making requests

Methods

alerts

autocomplete

connect

  • connect(name: string, url: string, username: string, password: string, timeout?: number): Promise<any>

  • Connect to an Twitarr server and return a TwitarrServer for that connection.

    Parameters

    • name: string
    • url: string
    • username: string
    • password: string
    • Optional timeout: number

    Returns Promise<any>

events

forums

isLoggedIn

  • isLoggedIn(): Promise<boolean>

photo

seamail

search

stream

text

user

Static checkServer

  • Given an TwitarrServer object, check that it can be connected to.

    Parameters

    • server: TwitarrServer

      the server to check

    • Optional httpImpl: ITwitarrHTTP

      the ITwitarrHTTP implementation to use

    • Optional timeout: number

      how long to wait before giving up when making ReST calls

    Returns Promise<boolean>

Generated using TypeDoc