Gjsify LogoGjsify Logo

Opaque structure. Use related accessor functions.

record

Hierarchy

  • Provider

Index

Constructors

Properties

name: string

Methods

  • getDescription(): string
  • getDisplayName(): string
  • getDomainsRegex(): string
  • Get a regular expression matching all domains where this provider's accounts can be used.

    Returns string

  • getFileContents(contents: string): void
  • Gets the contents of the XML provider file. The buffer returned in contents should not be modified or freed, and is guaranteed to be valid as long as provider is referenced. If some error occurs, contents is set to %NULL.

    Parameters

    • contents: string

      location to receive the pointer to the file contents.

    Returns void

  • getI18nDomain(): string
  • getIconName(): string
  • getName(): string
  • getPluginName(): string
  • Get the name of the account plugin which manages all accounts created from this #AgProvider. Some platforms might find it useful to store plugin names in the provider XML files, especially when the same plugin can work for different providers.

    Returns string

  • getSingleAccount(): boolean
  • Tell whether the provider doesn't support creating more than one account. Note that libaccounts itself does not enforce preventing the creation of multiple accounts when this flag is set: the flag is only informative, and its implementation is left to the client.

    Returns boolean

  • matchDomain(domain: string): boolean
  • Check whether domain is supported by this provider, by matching it with the regex returned by ag_provider_get_domains_regex(). If the provider does not define a regular expression to match the supported domains, this function will return %FALSE.

    Parameters

    • domain: string

      a domain name.

    Returns boolean

  • unref(): void

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