Normandy Study API

Permissions: normandyAddonStudy

Study
onUnenroll
endStudy
getClientMetadata
getStudy
onUnenroll: WebExtEvent<(reason: string) => void>

Fired when a user unenrolls from a study but before the addon is uninstalled.

The reason why the study is ending.

  • Marks the study as ended and then uninstalls the addon.

    Parameters

    • reason: string

      The reason why the study is ending.

    Returns Promise<any>

  • Returns an object with metadata about the client which may be required for constructing survey URLs.

    Returns Promise<any>

  • Returns a study object for the current study.

    Returns Promise<any>