Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PrivateMessagesApi

Hierarchy

  • PrivateMessagesApi

Index

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Properties

Protected _basePath

_basePath: string = defaultBasePath

Protected _defaultHeaders

_defaultHeaders: any

Protected _useQuerystring

_useQuerystring: boolean = false

Protected interceptors

interceptors: Interceptor[] = []

Accessors

basePath

  • get basePath(): string
  • set basePath(basePath: string): void

defaultHeaders

  • get defaultHeaders(): any
  • set defaultHeaders(defaultHeaders: any): void

useQuerystring

  • set useQuerystring(value: boolean): void

Methods

addInterceptor

postsJsonPost

  • summary

    Creates a new topic, a new post, or a private message

    Parameters

    • Optional inlineObject9: InlineObject9
    • Default value options: { headers: {} } = {headers: {}}
      • headers: {}
        • [name: string]: string

    Returns Promise<{ body: InlineResponse20017; response: IncomingMessage }>

setApiKey

setDefaultAuthentication

topicsPrivateMessagesSentUsernameJsonGet

  • topicsPrivateMessagesSentUsernameJsonGet(username: string, options?: { headers: {} }): Promise<{ body: InlineResponse20023; response: IncomingMessage }>
  • summary

    Get a list of private messages sent for a user

    Parameters

    • username: string
    • Default value options: { headers: {} } = {headers: {}}
      • headers: {}
        • [name: string]: string

    Returns Promise<{ body: InlineResponse20023; response: IncomingMessage }>

topicsPrivateMessagesUsernameJsonGet

  • topicsPrivateMessagesUsernameJsonGet(username: string, options?: { headers: {} }): Promise<{ body: InlineResponse20022; response: IncomingMessage }>
  • summary

    Get a list of private messages for a user

    Parameters

    • username: string
    • Default value options: { headers: {} } = {headers: {}}
      • headers: {}
        • [name: string]: string

    Returns Promise<{ body: InlineResponse20022; response: IncomingMessage }>

Object literals

Protected authentications

authentications: object

default

default: Authentication = <Authentication>new VoidAuth()

Generated using TypeDoc