Member Junction
    Preparing search index...

    Interface ShareNotificationInput

    Input to CreateShareNotification — everything needed to deliver a share notification to the grantee of a newly-created permission record.

    interface ShareNotificationInput {
        ActionsSummary?: string;
        ContextUser: UserInfo;
        ExtraConfiguration?: Record<string, unknown>;
        GranteeUserID: string;
        GrantorUserID: string;
        Message?: string;
        Provider: IMetadataProvider;
        ResourceName?: string;
        ResourceRecordID: string;
        ResourceTypeLabel: string;
        ResourceTypeName?: string;
        Title?: string;
    }
    Index

    Properties

    ActionsSummary? ContextUser ExtraConfiguration? GranteeUserID GrantorUserID Message? Provider ResourceName? ResourceRecordID ResourceTypeLabel ResourceTypeName? Title?

    Properties

    ActionsSummary?: string

    Short sentence describing what was granted. Goes in the notification body.

    ContextUser: UserInfo

    Context user to authorize the save.

    ExtraConfiguration?: Record<string, unknown>

    Extra JSON payload for the notification (e.g., PermissionID, DomainName).

    GranteeUserID: string

    ID of the user receiving the share — the to and the notification recipient.

    GrantorUserID: string

    ID of the user who granted the share — the from.

    Message?: string

    Optional override for the notification message body. When omitted, the dispatcher auto-generates a short sentence from ActionsSummary.

    Provider: IMetadataProvider

    Metadata provider — must be the Database provider (server-side).

    ResourceName?: string

    Optional display name for the shared resource.

    ResourceRecordID: string

    Primary key of the shared resource.

    ResourceTypeLabel: string

    Human-readable resource type label used in notification text (e.g., "Dashboard", "Collection"). Distinct from ResourceTypeName below — this is purely cosmetic.

    ResourceTypeName?: string

    Optional name from the MJResourceTypeEntity catalog (e.g., "Dashboards", "Artifacts", "Records"). When provided AND found in the catalog, the resolved ResourceType.ID is written to MJUserNotification.ResourceTypeID so the bell icon can deep-link via the matching DriverClass.

    Title?: string

    Optional override for the notification title. When omitted, the dispatcher auto-generates "<grantor> shared <resource> with you". Used by access-request workflow notifications (e.g., "New request for access to …") that don't match the default share-event phrasing.

    Settings

    Member Visibility

    On This Page

    Properties