PsChannelAction - kewalsk/My-OpenPeriscope GitHub Wiki

PsChannelAction

The PsChannelAction class describes one action in channel.

Name Type Description Optional
ActionType String The action type No
BroadcastId String The broadcast id if applicable No
CID String The channel id No
ChannelName String The channel named if applicable (for rename action) No
Time datetime The date and time of action No
MemberId String The user id if applicable (i.e. for add and remove actions) No
ById String The user id of member who did the action No
ActorDetails * PsActorDetail The Actor Detail class Yes
BroadcasterUserID * String Should be the user id of broadcaster but has no value Yes
TagName * String ? Yes
CategoryName * String ? Yes
Note * String ? Yes
BannedUserID * String ? Yes
BanReasonCode * int ? Yes
BotmakerDeviceID * String ? Yes

The fields marked by * are not present in application sources, but the server is sending them in response. However most of them has no meaningful value currently.

ActionType values

Value Description
c The channel was created
a User was added to the channel
r User was removed from the channel
s The broadcast was shared to the channel
b The private broadcast was sent to the channel
u The channel name was changed

Examples

Action of adding user to the channel:

 {
            "ById": "1DLKBgwDMDmjJ",
            "ActionType": "a",
            "CID": "***",
            "Time": "2019-08-11T10:36:21.993210927Z",
            "ActorDetails": {
                "class_name": "",
                "id": "",
                "created_at": null,
                "is_beta_user": false,
                "is_employee": false,
                "is_twitter_verified": false,
                "twitter_screen_name": "",
                "username": "",
                "display_name": "",
                "description": "",
                "profile_image_urls": null,
                "initials": "",
                "n_followers": 0,
                "n_following": 0,
                "n_hearts": 0
            },
            "MemberId": "1xkQDgmGOwPEz",
            "BroadcastId": "",
            "ChannelName": "",
            "BroadcasterUserID": "",
            "TagName": "",
            "CategoryName": "",
            "Note": "",
            "BannedUserID": "",
            "BanReasonCode": 0,
            "BotmakerDeviceID": ""
        }

Action of removing user from the channel:

 {
            "ById": "1wBKAYXXLJZKP",
            "ActionType": "r",
            "CID": "***",
            "Time": "2019-08-11T06:07:45.850343187Z",
            "ActorDetails": {
                "class_name": "",
                "id": "",
                "created_at": null,
                "is_beta_user": false,
                "is_employee": false,
                "is_twitter_verified": false,
                "twitter_screen_name": "",
                "username": "",
                "display_name": "",
                "description": "",
                "profile_image_urls": null,
                "initials": "",
                "n_followers": 0,
                "n_following": 0,
                "n_hearts": 0
            },
            "MemberId": "1wBKAYXXLJZKP",
            "BroadcastId": "",
            "ChannelName": "",
            "BroadcasterUserID": "",
            "TagName": "",
            "CategoryName": "",
            "Note": "",
            "BannedUserID": "",
            "BanReasonCode": 0,
            "BotmakerDeviceID": ""
        }

Action of sharing broadcast to the channel:

 {
            "ById": "1mMKPRVRqgyEG",
            "ActionType": "s",
            "CID": "***",
            "Time": "2019-08-11T09:11:16.086766418Z",
            "ActorDetails": {
                "class_name": "",
                "id": "",
                "created_at": null,
                "is_beta_user": false,
                "is_employee": false,
                "is_twitter_verified": false,
                "twitter_screen_name": "",
                "username": "",
                "display_name": "",
                "description": "",
                "profile_image_urls": null,
                "initials": "",
                "n_followers": 0,
                "n_following": 0,
                "n_hearts": 0
            },
            "MemberId": "",
            "BroadcastId": "1MYxNdMeDnpGw",
            "ChannelName": "",
            "BroadcasterUserID": "",
            "TagName": "",
            "CategoryName": "",
            "Note": "",
            "BannedUserID": "",
            "BanReasonCode": 0,
            "BotmakerDeviceID": ""
        }

Action of private broadcast:

 {
            "ById": "1drjerdZpgyEb",
            "ActionType": "b",
            "CID": "***",
            "Time": "2019-08-11T07:11:49.649169581Z",
            "ActorDetails": {
                "class_name": "",
                "id": "",
                "created_at": null,
                "is_beta_user": false,
                "is_employee": false,
                "is_twitter_verified": false,
                "twitter_screen_name": "",
                "username": "",
                "display_name": "",
                "description": "",
                "profile_image_urls": null,
                "initials": "",
                "n_followers": 0,
                "n_following": 0,
                "n_hearts": 0
            },
            "MemberId": "",
            "BroadcastId": "1lPKqoOPOzEJb",
            "ChannelName": "",
            "BroadcasterUserID": "",
            "TagName": "",
            "CategoryName": "",
            "Note": "",
            "BannedUserID": "",
            "BanReasonCode": 0,
            "BotmakerDeviceID": ""
        }
⚠️ **GitHub.com Fallback** ⚠️