Class IgnoredInvites

A container for ignored invites.

Performance

This implementation is extremely naive. It expects that we are dealing with a very short list of sources (e.g. only one). If real-world applications turn out to require longer lists, we may need to rework our data structures.

Constructors

constructor

Properties

client

Methods

addRule addSource getIgnoreInvitesPolicies getOrCreateSourceRooms getOrCreateTargetRoom getPoliciesAndIgnoreInvitesPolicies getRuleForInvite removeRule withIgnoreInvitesPolicies

Constructors

constructor

Properties

Private Readonly client

client: MatrixClient

Methods

addRule

  • addRule(scope, entity, reason): Promise<string>

  • Add a new rule.

    Parameters

    • scope: PolicyScope

      The scope for this rule.

    • entity: string

      The entity covered by this rule. Globs are supported.

    • reason: string

      A human-readable reason for introducing this new rule.

    Returns Promise<string>

    The event id for the new rule.

addSource

  • addSource(roomId): Promise<boolean>

  • Add a new room to the list of sources. If the user isn't a member of the room, attempt to join it.

    Parameters

    • roomId: string

      A valid room id. If this room is already in the list of sources, it will not be duplicated.

    Returns Promise<boolean>

    true if the source was added, false if it was already present.

    Throws

    If roomId isn't the id of a room that the current user is already member of or can join.

    Safety

    This method will rewrite the Policies object in the user's account data. This rewrite is inherently racy and could overwrite or be overwritten by other concurrent rewrites of the same object.

Private getIgnoreInvitesPolicies

  • getIgnoreInvitesPolicies(): {
        [key: string]: any;
    }

  • Fetch the IGNORE_INVITES_POLICIES object from account data.

    If both an unstable prefix version and a stable prefix version are available, it will return the stable prefix version preferentially.

    The result is not validated but is guaranteed to be a non-null object.

    Returns {
        [key: string]: any;
    }

    A non-null object.

    • [key: string]: any

getOrCreateSourceRooms

  • getOrCreateSourceRooms(): Promise<Room[]>

  • Get the list of source rooms, i.e. the rooms from which rules need to be read.

    If no source rooms are setup, the target room is used as sole source room.

    Note: This method is public for testing reasons. Most clients should not need to call it directly.

    Safety

    This method will rewrite the Policies object in the user's account data. This rewrite is inherently racy and could overwrite or be overwritten by other concurrent rewrites of the same object.

    Returns Promise<Room[]>

getOrCreateTargetRoom

  • getOrCreateTargetRoom(): Promise<Room>

  • Get the target room, i.e. the room in which any new rule should be written.

    If there is no target room setup, a target room is created.

    Note: This method is public for testing reasons. Most clients should not need to call it directly.

    Safety

    This method will rewrite the Policies object in the user's account data. This rewrite is inherently racy and could overwrite or be overwritten by other concurrent rewrites of the same object.

    Returns Promise<Room>

Private getPoliciesAndIgnoreInvitesPolicies

  • getPoliciesAndIgnoreInvitesPolicies(): {
        ignoreInvitesPolicies: {
            [key: string]: any;
        };
        policies: {
            [key: string]: any;
        };
    }

  • As getIgnoreInvitesPolicies but also return the POLICIES_ACCOUNT_EVENT_TYPE object.

    Returns {
        ignoreInvitesPolicies: {
            [key: string]: any;
        };
        policies: {
            [key: string]: any;
        };
    }

    • ignoreInvitesPolicies: {
          [key: string]: any;
      }
      • [key: string]: any
    • policies: {
          [key: string]: any;
      }
      • [key: string]: any

getRuleForInvite

  • getRuleForInvite(params): Promise<Readonly<null | MatrixEvent>>

  • Find out whether an invite should be ignored.

    Parameters

    • params: {
          roomId: string;
          sender: string;
      }
      • roomId: string

        The room to which the user is invited.

      • sender: string

        The user id for the user who issued the invite.

    Returns Promise<Readonly<null | MatrixEvent>>

    A rule matching the entity, if any was found, null otherwise.

removeRule

Private withIgnoreInvitesPolicies

  • withIgnoreInvitesPolicies(cb): Promise<void>

  • Modify in place the IGNORE_INVITES_POLICIES object from account data.

    Parameters

    • cb: ((ignoreInvitesPolicies) => void)
        • (ignoreInvitesPolicies): void

        • Parameters

          • ignoreInvitesPolicies: {
                [key: string]: any;
            }
            • [key: string]: any

          Returns void

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorclientaddRuleaddSourcegetIgnoreInvitesPoliciesgetOrCreateSourceRoomsgetOrCreateTargetRoomgetPoliciesAndIgnoreInvitesPoliciesgetRuleForInviteremoveRulewithIgnoreInvitesPolicies

Generated using TypeDoc