Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface magicTagTypeFactory

Describes the public API of factories that manage magic tag types

Hierarchy

  • magicTagTypeFactory

Index

Methods

Methods

addTag

  • addTag(tag: string, type: string): boolean

  • Add a tag to collection

    Parameters

    • tag: string

      The tag's text. For example "current_page_url" or "user:first_name"

    • type: string

      The type of tag -- email, text, etc.

    Returns boolean

getAllTags

  • Get all tags

    Returns magicTags

getTagsByType

  • Get tags by type

    Parameters

    • type: string

      The type of tag -- email, text, etc.

    Returns magicTags

removeTag

  • removeTag(tag: string): boolean

  • Remove a tag from collection

    Parameters

    • tag: string

      Tag to remove

    Returns boolean

updateTag

  • updateTag(oldTag: string, newTag: string, newType?: string): boolean

  • Update a tag

    Parameters

    • oldTag: string

      The old tag text

    • newTag: string

      The new tag text

    • Optional newType: string

    Returns boolean

Generated using TypeDoc