Cast’s Messages¶

Create new Cast’s Message or comment¶

This is method which you shoudl use to add new massege or comment to already existed message.

Arguments - you need send them POST parameters:

• body: message/comment body OPTIONAL
• topic_uid: one topic UID or list of topic UIDs, where message should be added. It’s ignored, when you send also uid argument!
• uid: message UID - ONLY IF YOU WANT TO ADD MESSAGE AS COMMENT TO THIS MESSAGE! OPTIONAL
• people: list of people IDs - for sharing/visibility set OPTIONAL
• eff_date: visibility date “from” OPTIONAL
• exp_date: visibility date “to” OPTIONAL
• files: uid of files wich you want attach to message. OPTIONAL
• references: uid of objects wich you want attach to message OPTIONAL
• with_comments: true/1 - show messgaes with comments OPTIONAL

How to call: * Send in header: Accept: application/json * POST request to: http://127.0.0.1:8080/Plone/<container>/<cast-topic> * BODY (content):

{
    "body": "Content of your message",
    ...  // rest of yor parameters
}

Update Cast’s Message or comment¶

This is method which you shoudl use to add new massege or comment to already existed message.

POST Arguments - you need send them POST parameters:

• uid: message UID REQUIRED
• body: message/comment body OPTIONAL
• eff_date: visibility date “from” OPTIONAL
• exp_date: visibility date “to” OPTIONAL
• files: uid of files wich you want attach to message. OPTIONAL
• references: uid of objects wich you want attach to message OPTIONAL
• with_comments: true/1 - show messgaes with comments OPTIONAL

How to call: * Send in header: Accept: application/json * PATCH request to: http://127.0.0.1:8080/Plone/<container>/<cast-topic>/message * BODY (content):

{
    "body": "Content of your message",
    ...  // rest of yor parameters
}

List of Cast’s Messages from topic¶

GET Arguments:

• text: text for search in message content OPTIONAL
• creator*: creator fullname or ID for grep messages only of this member OPTIONAL
• to_member: fullname or ID, for search only messages in which this member is mentioned (via @...:) OPTIONAL
• tag: tage name OPTIONAL
• content_filter: for filtering via content. available values: file, links, images, videos. OPTIONAL
• date_from: search messages from date. Timestamp! OPTIONAL
• date_from: search messages to date. Timestamp! OPTIONAL
• added_after: return messages added after. Timestamp! OPTIONAL
• readed: show readed (1, true) or not readed (0, flase) messages OPTIONAL
• with_comments: true/1 - show messgaes with comments OPTIONAL
• offset: offest - default 0 OPTIONAL
• limit: limit - default 20 OPTIONAL
• top_comments: only top level of comments (1, true, 0, false) OPTIONAL

This method return items in dictionary:

...
"items": {
    "messages": []
    "new_messages": null,
    "modified_messages": null
 },
...

In typical way, new_messages and modified_messages are empty (null), and messages contain messages dicts. If you send in request added_after, then messages will be none, and in new_messages and modified_messages will contain messages added after added_after. In this case, messages are not returned in tree structure, but as plain list. You should care about that, how and where you need add messages on frontend side. If message have parent_uid set as null, this mean it’s just new message. If parent_uid is not null, that means, you shoudl add this message as comment to message with UID parent_uid.

{
   "count": {
      "messages": 4,
      "new_messages": 0,
      "modified_messages": 0
   },
   "pagesize": 20,
   "items": {
      "messages": [
         {
            "raw_text": "foo bar bar foo",
            "uid": "ad8e44dfab2a4e628c35174adb143a36",
            "effective": "1969-12-31T00:00:00+01:00",
            "title": "foo bar bar foo",
            "read": true,
            "text": "foo bar bar foo",
            "portal_type": "Cast Update",
            "created": "2015-12-07T17:02:02+01:00",
            "modified": "2015-12-07T17:02:02+01:00",
            "comments": [],
            "id": "1449504122397463",
            "parent_id": "0",
            "tags": [],
            "images": [],
            "creator": {
               "fullname": "admin",
               "UID": "admin",
               "image": {
                  "URL": "http://127.0.0.1:8080/Plone/portal_memberdata/portraits/admin",
                  "alt": "admin"
               }
            },
            "parent_uid": null,
            "refs": []
         },
         ...
      ],
      "new_messages": null,
      "modified_messages": null
   },
   "pages": 1,
   "next": null,
   "_runtime": 0.10978913,
   "page": 1,
   "previous": null
}

Cast Message details¶

This method returing details about message with UID define by MESSAGE_UID in URL.

Arguments

• MESSAGE_UID - message uid REQUIRED
• with_comments: true/1 - show messgaes with comments OPTIONAL

Result:

{
   "raw_text": "foo bar bar foo",
   "uid": "ad8e44dfab2a4e628c35174adb143a36",
   "effective": "1969-12-31T00:00:00+01:00",
   "title": "foo bar bar foo",
   "read": true,
   "text": "foo bar bar foo",
   "portal_type": "Cast Update",
   "created": "2015-12-07T17:02:02+01:00",
   "modified": "2015-12-07T17:02:02+01:00",
   "comments": [],
   "id": "1449504122397463",
   "parent_id": "0",
   "tags": [],
   "images": [],
   "_runtime": 0.026704073,
   "creator": {
      "fullname": "admin",
      "UID": "admin",
      "image": {
         "URL": "http://127.0.0.1:8080/Plone/portal_memberdata/portraits/admin",
         "alt": "admin"
      }
   },
   "parent_uid": null,
   "refs": []
}

Following of cast message¶

Method for enabling/disabling following message by current loggedin member. FOLLOW shoudl be 1 or 0. 1 means follow, 0 means unfollow.

How to call: * Send in header: Accept: application/json * POST request to: http://127.0.0.1:8080/Plone/<container>/<cast-topic>/toggle_follow * BODY (content):

{
    "uid": "<message-uid>",
    "follow": 1,
}

Result:

{
    "text": "Stop following replies",
    "_runtime": 0.07516098022460938,
    "result": "success",
    "class": "stopFollowMessageAction"
}

{
    "text": "You are not following this message.",
    "result": "error",
    "_runtime": 0.017998933792114258
}

{
    "text": "Follow message replies",
    "_runtime": 0.07190203666687012,
    "result": "success",
    "class": "startFollowMessageAction"
}

Delete cast message¶

Method for deleting cast’s messages.

How to call: * Send in header: Accept: application/json * DELETE request to: http://127.0.0.1:8080/Plone/<container>/<cast-topic>/message * BODY (content):

{
    "uid": "<message-uid>",
}

Result:

{
    "_runtime": 0.2651090621948242,
    "success": "Message was successfully removed."
}