Variable DiscussionControlsConst

Type Declaration

• controls: function

  • controls(
        discussion: Discussion,
        context: Component<any, any>,
    ): ItemList<Children>

    Get a list of controls for a discussion.

    Parameters

    • discussion: Discussion
    • context: Component<any, any>

      The parent component under which the controls menu will be displayed.

    Returns ItemList<Children>

• deleteAction: function

  • deleteAction(): Promise<void>

    Delete the discussion after confirming with the user.

    Returns Promise<void>

• destructiveControls: function

  • destructiveControls(discussion: Discussion): ItemList<Children>
    Protected

    Get controls for a discussion which are destructive (e.g. delete).

    Parameters

    • discussion: Discussion

    Returns ItemList<Children>

• hideAction: function

  • hideAction(): Promise<void>

    Hide a discussion.

    Returns Promise<void>

• moderationControls: function

  • moderationControls(discussion: Discussion): ItemList<Children>
    Protected

    Get controls for a discussion pertaining to moderation (e.g. rename, lock).

    Parameters

    • discussion: Discussion

    Returns ItemList<Children>

• renameAction: function

  • renameAction(): any

    Rename the discussion.

    Returns any

• replyAction: function

  • replyAction(
        goToLast: boolean,
        forceRefresh: boolean,
    ): Promise<forum/states/ComposerState>

    Open the reply composer for the discussion. A promise will be returned, which resolves when the composer opens successfully. If the user is not logged in, they will be prompted. If they don't have permission to reply, the promise will be rejected.

    Parameters

    • goToLast: boolean

      Whether or not to scroll down to the last post if the discussion is being viewed.

    • forceRefresh: boolean

      Whether or not to force a reload of the composer component, even if it is already open for this discussion.

    Returns Promise<forum/states/ComposerState>

• restoreAction: function

  • restoreAction(): Promise<void>

    Restore a discussion.

    Returns Promise<void>

• userControls: function

  • userControls(
        discussion: Discussion,
        context: Component<any, any>,
    ): ItemList<Children>
    Protected

    Get controls for a discussion pertaining to the current user (e.g. reply, follow).

    Parameters

    • discussion: Discussion
    • context: Component<any, any>

      The parent component under which the controls menu will be displayed.

    Returns ItemList<Children>