Index

Variables

ContainerColor

ContainerColor: string[] = ["blue","turquoise","green","yellow","orange","red","pink","purple",]

ContainerIcon

ContainerIcon: string[] = ["fingerprint","briefcase","dollar","cart","circle","gift","vacation","food","fruit","pet","tree","chill",]

logger

logger: Logger = new Logging.Logger("containers")

Functions

chooseRandomColor

  • chooseRandomColor(): string
  • Helper function for create, returns a random valid IdentityColor for use if no color is applied at creation.

    Returns string

create

  • create(name: string, color?: string, icon?: string): Promise<string>
  • Creates a container from the specified parameters.Does not allow multiple containers with the same name. @param name The container name. @param color The container color, must be one of: "blue", "turquoise", "green", "yellow", "orange", "red", "pink" or "purple". If nothing is supplied, it selects one at random. @param icon The container icon, must be one of: "fingerprint", "briefcase", "dollar", "cart", "circle", "gift", "vacation", "food", "fruit", "pet", "tree", "chill"

    Parameters

    • name: string
    • Default value color: string = "random"
    • Default value icon: string = "fingerprint"

    Returns Promise<string>

exists

  • exists(cname: string): Promise<boolean>
  • Queries Firefox's contextual identities API for a container with a specific name. @param string cname @returns boolean Returns true when cname matches an existing container or on query error.

    Parameters

    • cname: string

    Returns Promise<boolean>

fromString

  • fromString(name: string, color: string, icon: string): object
  • Takes string parameters and returns them as a pseudo container object for use in other functions in the library. @param name @param color @param icon

    Parameters

    • name: string
    • color: string
    • icon: string

    Returns object

    • color: "blue" | "turquoise" | "green" | "yellow" | "orange" | "red" | "pink" | "purple"
    • icon: "fingerprint" | "briefcase" | "dollar" | "cart" | "circle"
    • name: string

fuzzyMatch

  • fuzzyMatch(partialName: string): Promise<string>
  • Tries some simple ways to match containers to your input. @param partialName The (partial) name of the container.

    Parameters

    • partialName: string

    Returns Promise<string>

getAll

  • getAll(): Promise<any[]>

getFromId

  • getFromId(containerId: string): Promise<__type>
  • Gets a container object from a supplied container id string. @param containerId Expects a cookieStringId e.g. "firefox-container-n"

    Parameters

    • containerId: string

    Returns Promise<__type>

getId

  • getId(name: string): Promise<string>
  • Parameters

    • name: string

      The container name

    Returns Promise<string>

    The cookieStoreId of the first match of the query.

isValidColor

  • isValidColor(color: string): boolean

isValidIcon

  • isValidIcon(icon: string): boolean

remove

  • remove(name: string): Promise<void>
  • Removes specified container. No fuzzy matching is intentional here. If there are multiple containers with the same name (allowed by other container plugins), it chooses the one with the lowest cookieStoreId @param name The container name

    Parameters

    • name: string

    Returns Promise<void>

update

  • update(containerId: string, updateObj: object): Promise<void>
  • Updates the specified container. TODO: pass an object to this when tridactyl gets proper flag parsing NOTE: while browser.contextualIdentities.create does check for valid color/icon combos, browser.contextualIdentities.update does not. @param containerId Expects a cookieStringId e.g. "firefox-container-n". @param name the new name of the container @param color the new color of the container @param icon the new icon of the container

    Parameters

    • containerId: string
    • updateObj: object
      • color: browser.contextualIdentities.IdentityColor
      • icon: browser.contextualIdentities.IdentityIcon
      • name: string

    Returns Promise<void>