Class Instance

constructor

• new Instance(
      json: {
          branches: {
              [key: string]: {
                  checkinCounters: {
                      [key: string]: { label: string; shortLabel: string };
                  };
                  guestlistLabel: string;
                  title: string;
              };
          };
          description: string;
          dynamicTags: {
              [key: string]: { color: string; filter?: { query: null
              | string } };
          };
          frontend: { domain: string };
          guestNameFields: string[];
          name: string;
          registration: {
              allowRegistrationWithAuthCode: boolean;
              canEdit: boolean;
              closed: boolean;
              editEnd: null | string;
              end: null | string;
              start: null | string;
          };
          tagColors: { [key: string]: string };
          thumbnail: boolean;
          title: string;
      },
  ): Instance

  Parameters

  • json: {
        branches: {
            [key: string]: {
                checkinCounters: {
                    [key: string]: { label: string; shortLabel: string };
                };
                guestlistLabel: string;
                title: string;
            };
        };
        description: string;
        dynamicTags: {
            [key: string]: { color: string; filter?: { query: null
            | string } };
        };
        frontend: { domain: string };
        guestNameFields: string[];
        name: string;
        registration: {
            allowRegistrationWithAuthCode: boolean;
            canEdit: boolean;
            closed: boolean;
            editEnd: null | string;
            end: null | string;
            start: null | string;
        };
        tagColors: { [key: string]: string };
        thumbnail: boolean;
        title: string;
    }

    • branches: {
          [key: string]: {
              checkinCounters: {
                  [key: string]: { label: string; shortLabel: string };
              };
              guestlistLabel: string;
              title: string;
          };
      }

      Branches

    • description: string

      Description

    • dynamicTags: { [key: string]: { color: string; filter?: { query: null | string } } }

      Dynamictags

    • frontend: { domain: string }

      • domain: string

        Domain

    • guestNameFields: string[]

      Guestnamefields

    • name: string

      Name

    • registration: {
          allowRegistrationWithAuthCode: boolean;
          canEdit: boolean;
          closed: boolean;
          editEnd: null | string;
          end: null | string;
          start: null | string;
      }

      • allowRegistrationWithAuthCode: boolean

        Allowregistrationwithauthcode

        Default

        false
        Copy

      • canEdit: boolean

        Canedit

        Default

        false
        Copy

      • closed: boolean

        Closed

        Default

        false
        Copy

      • editEnd: null | string

        Editend

      • end: null | string

        End

      • start: null | string

        Start

    • tagColors: { [key: string]: string }

      Tagcolors

      Deprecated

    • thumbnail: boolean

      Thumbnail

    • title: string

      Title

  Returns Instance

branches

description

dynamicTags

frontend

guestNameFields

hasTumbnail

name

registration

title

canEditRegistration

• canEditRegistration(): boolean

  Returns boolean

formatName

• formatName(guest: Attendee): string

  Parameters

  • guest: Attendee

  Returns string

getTagColor

• getTagColor(tag: string): undefined | string

  Parameters

  • tag: string

  Returns undefined | string

isRegistrationClosed

• isRegistrationClosed(): boolean

  Returns boolean

toJSON

• toJSON(): {
      branches: {
          [key: string]: {
              checkinCounters: {
                  [key: string]: { label: string; shortLabel: string };
              };
              guestlistLabel: string;
              title: string;
          };
      };
      description: string;
      dynamicTags: {
          [key: string]: { color: string; filter?: { query: null
          | string } };
      };
      frontend: { domain: string };
      guestNameFields: string[];
      name: string;
      registration: {
          allowRegistrationWithAuthCode: boolean;
          canEdit: boolean;
          closed: boolean;
          editEnd: null | string;
          end: null | string;
          start: null | string;
      };
      tagColors: { [key: string]: string };
      thumbnail: boolean;
      title: string;
  }

  Returns {
      branches: {
          [key: string]: {
              checkinCounters: {
                  [key: string]: { label: string; shortLabel: string };
              };
              guestlistLabel: string;
              title: string;
          };
      };
      description: string;
      dynamicTags: {
          [key: string]: { color: string; filter?: { query: null
          | string } };
      };
      frontend: { domain: string };
      guestNameFields: string[];
      name: string;
      registration: {
          allowRegistrationWithAuthCode: boolean;
          canEdit: boolean;
          closed: boolean;
          editEnd: null | string;
          end: null | string;
          start: null | string;
      };
      tagColors: { [key: string]: string };
      thumbnail: boolean;
      title: string;
  }

  • branches: {
        [key: string]: {
            checkinCounters: {
                [key: string]: { label: string; shortLabel: string };
            };
            guestlistLabel: string;
            title: string;
        };
    }

    Branches

  • description: string

    Description

  • dynamicTags: { [key: string]: { color: string; filter?: { query: null | string } } }

    Dynamictags

  • frontend: { domain: string }

    • domain: string

      Domain

  • guestNameFields: string[]

    Guestnamefields

  • name: string

    Name

  • registration: {
        allowRegistrationWithAuthCode: boolean;
        canEdit: boolean;
        closed: boolean;
        editEnd: null | string;
        end: null | string;
        start: null | string;
    }

    • allowRegistrationWithAuthCode: boolean

      Allowregistrationwithauthcode

      Default

      false
      Copy

    • canEdit: boolean

      Canedit

      Default

      false
      Copy

    • closed: boolean

      Closed

      Default

      false
      Copy

    • editEnd: null | string

      Editend

    • end: null | string

      End

    • start: null | string

      Start

  • tagColors: { [key: string]: string }

    Tagcolors

    Deprecated

  • thumbnail: boolean

    Thumbnail

  • title: string

    Title