Gjsify LogoGjsify Logo

Hierarchy

  • Provider

Index

Constructors

Properties

authtypes: object[]
description: string
domain: string
extra_conf: ProviderConfEntry
name: string
object_types: GType<unknown>[]
port_entries: ProviderPortEntry
priv: object
protocol: string
translation_domain: string
url_equal: EqualFunc
url_flags: ProviderURLFlags
url_hash: HashFunc
name: string

Methods

  • register(): void
  • Returns the registered #CamelProvider for protocol, loading it from disk if necessary. If no #CamelProvider can be found for protocol, or the provider module fails to load, the function sets error and returns %NULL.

    The returned #CamelProvider is owned by Camel and should not be modified or freed.

    Parameters

    • protocol: string

      a #CamelProvider protocol name

    Returns Camel.Provider

  • init(): void
  • Initialize the Camel provider system by reading in the .urls files in the provider directory and creating a hash table mapping URLs to module names.

    A .urls file has the same initial prefix as the shared library it correspond to, and consists of a series of lines containing the URL protocols that that library handles.

    TODO: This should be pathed? TODO: This should be plugin-d?

    Returns void

  • This returns a list of available providers. If load is %TRUE, it will first load in all available providers that haven't yet been loaded.

    Free the returned list with g_list_free(). The #CamelProvider structs in the list are owned by Camel and should not be modified or freed.

    Parameters

    • load: boolean

      whether or not to load in providers that are not already loaded

    Returns Camel.Provider[]

  • load(path: string): boolean
  • Loads the provider at path, and calls its initialization function, passing session as an argument. The provider should then register itself with session.

    Parameters

    • path: string

      the path to a shared library

    Returns boolean

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