Gjsify LogoGjsify Logo

The requirements for setting an avatar on a particular protocol.

record

Hierarchy

  • AvatarRequirements

Index

Constructors

  • new AvatarRequirements(supported_mime_types: string[], minimum_width: number, minimum_height: number, recommended_width: number, recommended_height: number, maximum_width: number, maximum_height: number, maximum_bytes: number): AvatarRequirements
  • Parameters

    • supported_mime_types: string[]

      An array of supported MIME types (e.g. "image/jpeg") Clients MAY assume that the first type in this array is preferred

    • minimum_width: number

      The minimum width in pixels of an avatar, which MAY be 0

    • minimum_height: number

      The minimum height in pixels of an avatar, which MAY be 0

    • recommended_width: number

      The recommended width in pixels of an avatar, or 0 if there is no preferred width.

    • recommended_height: number

      The recommended height in pixels of an avatar, or 0 if there is no preferred height

    • maximum_width: number

      The maximum width in pixels of an avatar on this protocol, or 0 if there is no limit.

    • maximum_height: number

      The maximum height in pixels of an avatar, or 0 if there is no limit.

    • maximum_bytes: number

      he maximum size in bytes of an avatar, or 0 if there is no limit.

    Returns AvatarRequirements

Properties

maximum_bytes: number

he maximum size in bytes of an avatar, or 0 if there is no limit.

field
maximum_height: number

The maximum height in pixels of an avatar, or 0 if there is no limit.

field
maximum_width: number

The maximum width in pixels of an avatar on this protocol, or 0 if there is no limit.

field
minimum_height: number

The minimum height in pixels of an avatar, which MAY be 0

field
minimum_width: number

The minimum width in pixels of an avatar, which MAY be 0

field
recommended_height: number

The recommended height in pixels of an avatar, or 0 if there is no preferred height

field
recommended_width: number

The recommended width in pixels of an avatar, or 0 if there is no preferred width.

field
supported_mime_types: string[]

An array of supported MIME types (e.g. "image/jpeg") Clients MAY assume that the first type in this array is preferred

field
name: string

Methods

  • new(supported_mime_types: string[], minimum_width: number, minimum_height: number, recommended_width: number, recommended_height: number, maximum_width: number, maximum_height: number, maximum_bytes: number): AvatarRequirements
  • Parameters

    • supported_mime_types: string[]

      An array of supported MIME types (e.g. "image/jpeg") Clients MAY assume that the first type in this array is preferred

    • minimum_width: number

      The minimum width in pixels of an avatar, which MAY be 0

    • minimum_height: number

      The minimum height in pixels of an avatar, which MAY be 0

    • recommended_width: number

      The recommended width in pixels of an avatar, or 0 if there is no preferred width.

    • recommended_height: number

      The recommended height in pixels of an avatar, or 0 if there is no preferred height

    • maximum_width: number

      The maximum width in pixels of an avatar on this protocol, or 0 if there is no limit.

    • maximum_height: number

      The maximum height in pixels of an avatar, or 0 if there is no limit.

    • maximum_bytes: number

      he maximum size in bytes of an avatar, or 0 if there is no limit.

    Returns AvatarRequirements

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method