@ua/react-native-airship/src/TagGroupEditor.ts

Airship plugin for React Native apps.

/* Copyright Airship and Contributors */

'use strict';

/**
 * Tag group operation.
 * @hidden
 */
export interface TagGroupOperation {
  /**
   * The operation name
   */
  operationType: string;
  /**
   * The tag group name
   */
  group: string;
  /**
   * An array of tags.
   */
  tags: string[];
}

/**
 * Editor for tag groups.
 */
export class TagGroupEditor {
  onApply: (operations: TagGroupOperation[]) => Promise<void>;
  operations: TagGroupOperation[];

  /**
   * TagGroupEditor constructor
   *
   * @hidden
   * @param onApply The apply function
   */
  constructor(onApply: (operations: TagGroupOperation[]) => Promise<void>) {
    this.onApply = onApply;
    this.operations = [];
  }

  /**
   * Adds tags to a tag group.
   *
   * @param tagGroup The tag group.
   * @param tags Tags to add.
   * @return The tag group editor instance.
   */
  addTags(group: string, tags: string[]): TagGroupEditor {
    const operation = { operationType: 'add', group: group, tags: tags };
    this.operations.push(operation);
    return this;
  }

  /**
   * Removes tags from the tag group.
   *
   * @param tagGroup The tag group.
   * @param tags Tags to remove.
   * @return The tag group editor instance.
   */
  removeTags(group: string, tags: string[]): TagGroupEditor {
    const operation = { operationType: 'remove', group: group, tags: tags };
    this.operations.push(operation);
    return this;
  }

  /**
   * Overwrite the current set of tags on the Tag Group.
   *
   * @param tagGroup The tag group.
   * @param tags Tags to set.
   * @return The tag group editor instance.
   */
  setTags(group: string, tags: Array<string>): TagGroupEditor {
    const operation = { operationType: 'set', group: group, tags: tags };
    this.operations.push(operation);
    return this;
  }

  /**
   * Applies the tag changes.
   */
  apply(): Promise<void> {
    return this.onApply(this.operations);
  }
}