Show:

HTTP Streams interest Class

Defined in: platform/plugins/Streams/handlers/Streams/interest/post.php:3
Module: Streams

Methods

post

(
  • $_REQUEST
)
Void

Defined in platform/plugins/Streams/handlers/Streams/interest/post.php:8

Used by HTTP clients to create a new interest in the system.

Parameters:

  • $_REQUEST Array
    • [title] String optional

      Required. The title of the interest.

    • [publisherId=Users::communityId()] String optional

      Optional. Defaults to the current community's id.

    • [subscribe] String optional

      Optional. Defauls to false. Whether to subscribe rather than just join the interest stream.

Returns:

Void:

Events

Streams/interest/delete

After

Provided by the Streams-tools module.

Defined in platform/plugins/Streams/handlers/Streams/interest/delete.php:54

Occurs when the logged-in user has successfully removed an interest via HTTP

Event Payload:

  • publisherId String

    The publisher of the interest stream

  • title String

    The title of the interest

  • user Users_User

    The logged-in user

  • stream Streams_Stream

    The interest stream

  • myInterests Streams_Stream

    The user's "Streams/user/interests" stream

Streams/interest/post

After

Defined in platform/plugins/Streams/handlers/Streams/interest/post.php:103

Occurs when the logged-in user has successfully added an interest via HTTP

Event Payload:

  • publisherId String

    The publisher of the interest stream

  • title String

    The title of the interest

  • subscribe Boolean

    Whether the user subscribed to the interest stream

  • user Users_User

    The logged-in user

  • stream Streams_Stream

    The interest stream

  • myInterests Streams_Stream

    The user's "Streams/user/interests" stream