Viv JavaScript Runtime - v0.10.2
    Preparing search index...

    Interface ActiveEmbargo

    An active embargo that has been asserted in the running simulation instance of the host application.

    interface ActiveEmbargo {
        actionName: string;
        bindings: RoleBindings | null;
        expiration: number | null;
        id: string;
        location: string | null;
    }
    Index

    Properties

    actionName: string

    The name of the action associated with this embargo.

    bindings: RoleBindings | null

    A mapping from a role name to an array of entity IDs for entities who the embargo prohibits from being cast in that role again (assuming the other embargo constraints hold). If the embargo places no such constraints, this field will be set to null.

    expiration: number | null

    The timestamp at which the embargo will be lifted, otherwise null for a permanent embargo.

    id: string

    A unique identifier for the embargo, provisioned by Viv.

    location: string | null

    If applicable, the entity ID for the location associated with this embargo.