Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Request

SHIORI Request Message Headers Container

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Request(header?: object): Request

Properties

header

header: object

headers

Type declaration

  • [name: string]: string | undefined

Accessors

Age

  • get Age(): undefined | number
  • set Age(value: undefined | number): void

  • Age header (SHIORI/2.3b)

    Returns undefined | number

  • Age header (SHIORI/2.3b)

    Parameters

    • value: undefined | number

    Returns void

Charset

  • get Charset(): undefined | string
  • set Charset(value: undefined | string): void

Event

  • get Event(): undefined | string
  • set Event(value: undefined | string): void

  • Event header (SHIORI/2.2)

    Returns undefined | string

  • Event header (SHIORI/2.2)

    Parameters

    • value: undefined | string

    Returns void

Ghost

  • get Ghost(): undefined | string
  • set Ghost(value: undefined | string): void

  • Ghost header (NOTIFY OwnerGhostName SHIORI/2.0,2.3)

    Returns undefined | string

  • Ghost header (NOTIFY OwnerGhostName SHIORI/2.0,2.3)

    Parameters

    • value: undefined | string

    Returns void

ID

  • get ID(): undefined | string
  • set ID(value: undefined | string): void

  • ID header (SHIORI/2.5,3.x)

    Returns undefined | string

  • ID header (SHIORI/2.5,3.x)

    Parameters

    • value: undefined | string

    Returns void

SecurityLevel

  • get SecurityLevel(): undefined | string
  • set SecurityLevel(value: undefined | string): void

  • SecurityLevel header (SHIORI/2.2,2.6,3.x)

    Returns undefined | string

  • SecurityLevel header (SHIORI/2.2,2.6,3.x)

    Parameters

    • value: undefined | string

    Returns void

Sender

  • get Sender(): undefined | string
  • set Sender(value: undefined | string): void

Sentence

  • get Sentence(): undefined | string
  • set Sentence(value: undefined | string): void

  • Sentence header (SHIORI/2.0,2.3b)

    Returns undefined | string

  • Sentence header (SHIORI/2.0,2.3b)

    Parameters

    • value: undefined | string

    Returns void

Status

  • get Status(): string[]
  • set Status(value: string[]): void

Surface

  • get Surface(): number[]
  • set Surface(value: number[]): void

To

  • get To(): undefined | string
  • set To(value: undefined | string): void

Type

  • get Type(): undefined | string
  • set Type(value: undefined | string): void

  • Type header (GET Word SHIORI/2.0)

    Returns undefined | string

  • Type header (GET Word SHIORI/2.0)

    Parameters

    • value: undefined | string

    Returns void

Word

  • get Word(): undefined | string
  • set Word(value: undefined | string): void

  • Word header (TEACH SHIORI/2.4)

    Returns undefined | string

  • Word header (TEACH SHIORI/2.4)

    Parameters

    • value: undefined | string

    Returns void

Methods

Reference

  • Reference(index: number): undefined | string

  • Reference* header (SHIORI/2.2-2.6,3.x)

    Parameters

    • index: number

      reference index

    Returns undefined | string

    header value

ReferenceSeparated

  • ReferenceSeparated(index: number, separator?: string): string[]

  • Reference* header (SHIORI/2.2-2.6,3.x)

    Parameters

    • index: number

      reference index

    • Default value separator: string = ""

      separator characters

    Returns string[]

    header values

ReferenceSeparated2

  • ReferenceSeparated2(index: number, separator1?: string, separator2?: string): string[][]

  • Reference* header (SHIORI/2.2-2.6,3.x)

    Parameters

    • index: number

      reference index

    • Default value separator1: string = ""

      first level separator characters

    • Default value separator2: string = ""

      second level separator characters

    Returns string[][]

    header values

get

  • get(name: string): undefined | string

  • get header

    Parameters

    • name: string

      header name

    Returns undefined | string

    header value

get_separated

  • get_separated(name: string, separator?: string): undefined | string[]

  • get header separated by \x01 or some as an array

    Parameters

    • name: string

      header name

    • Default value separator: string = ""

      separator characters

    Returns undefined | string[]

    header values

get_separated2

  • get_separated2(name: string, separator1?: string, separator2?: string): undefined | string[][]

  • get header separated by \x02 and \x01 or some as an array

    Parameters

    • name: string

      header name

    • Default value separator1: string = ""

      first level separator characters

    • Default value separator2: string = ""

      second level separator characters

    Returns undefined | string[][]

    header values

references

  • references(): (undefined | string)[]

set

  • set(name: string, value: string | undefined): undefined | string

  • set header

    header will be deleted if value == undefined

    Parameters

    • name: string

      header name

    • value: string | undefined

      header value

    Returns undefined | string

    header value

set_separated

  • set_separated(name: string, value: string[], separator?: string): string

  • set header separated by \x01 or some as an array

    Parameters

    • name: string

      header name

    • value: string[]

      header values

    • Default value separator: string = ""

      separator characters

    Returns string

    header value

set_separated2

  • set_separated2(name: string, value: string[][], separator1?: string, separator2?: string): string

  • set header separated by \x02 and \x01 or some as an array

    Parameters

    • name: string

      header name

    • value: string[][]

      header values

    • Default value separator1: string = ""

      first level separator characters

    • Default value separator2: string = ""

      second level separator characters

    Returns string

    header value

toString

  • toString(): string

validate

  • validate(): void

Generated using TypeDoc