Interface nsIUrlListManagerType

Interface for a class that manages updates of the url classifier database.

Hierarchy

Methods

AddRef QueryInterface Release checkForUpdates disableAllUpdates disableUpdate enableUpdate forceUpdates getBackOffTime getGethashUrl getUpdateUrl isRegistered maybeToggleUpdateChecking registerTable unregisterTable

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

checkForUpdates

  • This is currently used by about:url-classifier to force an update for the update url. Update may still fail because of backoff algorithm.

    Parameters

    • updateUrl: string

    Returns boolean

disableAllUpdates

  • Turn off update checking for all tables.

    Returns void

disableUpdate

  • Turn off update checking for a single table. Only used in tests.

    Parameters

    • tableName: string

    Returns void

enableUpdate

  • Turn on update checking for a table. I.e., during the next server check, download updates for this table.

    Parameters

    • tableName: string

    Returns void

forceUpdates

  • Force updates for the given tables, updates are still restricted to backoff algorithm.

    Parameters

    • tableNames: string

    Returns boolean

getBackOffTime

  • This is currently used by about:url-classifier to get back-off time (in millisecond since epoch) for the given provider. Return 0 if we are not in back-off mode.

    Parameters

    • provider: string

    Returns uint64_t

getGethashUrl

  • Get the gethash url for this table

    Parameters

    • tableName: string

    Returns string

getUpdateUrl

  • Get the update url for this table

    Parameters

    • tableName: string

    Returns string

isRegistered

  • Return true if someone registers a table, this is used by testcase to figure out it SafeBrowsing.jsm is initialized.

    Returns boolean

maybeToggleUpdateChecking

  • Toggle update checking, if necessary.

    Returns void

registerTable

  • Add a table to the list of tables we are managing. The name is a string of the format provider_name-semantic_type-table_type. For

    Parameters

    • tableName: string

      A string of the format provider_name-semantic_type-table_type. For example, goog-white-enchash or goog-black-url.

    • providerName: string

      The name of the entity providing the list.

    • updateUrl: string

      The URL from which to fetch updates.

    • gethashUrl: string

      The URL from which to fetch hash completions.

    Returns boolean

unregisterTable

  • Unregister table from the list

    Parameters

    • tableName: string

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc