UGC Service Events 0.1.0 documentation

Protobuf File Spec: ugc.proto

Published Messages (ugcContent)

The service publishes one of these messages below.

ugcContentUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContent": {
      "contentId": "string",
      "namespace": "string",
      "channel": "string",
      "userId": "string",
      "createdTime": "2019-08-24T14:15:22Z",
      "isOfficial": true,
      "updatedTime": "2019-08-24T14:15:22Z",
      "tags": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContent	ugcContent	-

ugcContentDeleted

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentDelete": {
      "namespace": "string",
      "contentId": "string",
      "userId": "string",
      "deleteBy": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentDelete	object	-

payload.ugcContentDelete

Name	Type	Description
namespace	string	-
contentId	string	-
userId	string	-
deleteBy	string	-

ugcContentHide

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentHide": {
      "namespace": "string",
      "contentId": "string",
      "userId": "string",
      "autoModeration": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentHide	ugcContentHide	-

ugcContentUnHide

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentHide": {
      "namespace": "string",
      "contentId": "string",
      "userId": "string",
      "autoModeration": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentHide	ugcContentHide	-

ugcContentCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContent": {
      "contentId": "string",
      "namespace": "string",
      "channel": "string",
      "userId": "string",
      "createdTime": "2019-08-24T14:15:22Z",
      "isOfficial": true,
      "updatedTime": "2019-08-24T14:15:22Z",
      "tags": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContent	ugcContent	-

ugcContentLiked

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentLike": {
      "namespace": "string",
      "userId": "string",
      "creatorId": "string",
      "contentId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentLike	ugcContentLike	-

ugcContentUnLiked

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentLike": {
      "namespace": "string",
      "userId": "string",
      "creatorId": "string",
      "contentId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentLike	ugcContentLike	-

Published Messages (ugcChannel)

The service publishes one of these messages below.

ugcChannelCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcChannel": {
      "namespace": "string",
      "channelId": "string",
      "userId": "string",
      "channelName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcChannel	ugcChannel	-

ugcChannelUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcChannel": {
      "namespace": "string",
      "channelId": "string",
      "userId": "string",
      "channelName": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcChannel	ugcChannel	-

ugcChannelDeleted

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcChannel": {
      "namespace": "string",
      "channelId": "string",
      "userId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcChannel	object	-

payload.ugcChannel

Name	Type	Description
namespace	string	-
channelId	string	-
userId	string	-

Published Messages (ugcCreator)

The service publishes one of these messages below.

ugcCreatorCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcCreator": {
      "namespace": "string",
      "userId": "string",
      "creatorId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcCreator	ugcCreator	-

ugcCreatorFollowed

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcCreator": {
      "namespace": "string",
      "userId": "string",
      "creatorId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcCreator	ugcCreator	-

ugcCreatorUnFollowed

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcCreator": {
      "namespace": "string",
      "userId": "string",
      "creatorId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcCreator	ugcCreator	-

ugcCreatorDeleted

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcCreator": {
      "namespace": "string",
      "userId": "string",
      "creatorId": "string"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcCreator	ugcCreator	-

ugcCreatorBanned

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcCreatorBan": {
      "namespace": "string",
      "userId": "string",
      "reason": "string",
      "type": "string",
      "enable": true,
      "endDate": "2019-08-24T14:15:22Z"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcCreatorBan	ugcCreatorBan	-

ugcCreatorUnBanned

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcCreatorBan": {
      "namespace": "string",
      "userId": "string",
      "reason": "string",
      "type": "string",
      "enable": true,
      "endDate": "2019-08-24T14:15:22Z"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcCreatorBan	ugcCreatorBan	-

Published Messages (ugcContentGroup)

The service publishes one of these messages below.

ugcContentGroupCreated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentGroup": {
      "namespace": "string",
      "groupId": "string",
      "name": "string",
      "userId": "string",
      "contents": [
        "string"
      ],
      "createdTime": "2019-08-24T14:15:22Z"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentGroup	ugcContentGroup	-

ugcContentGroupUpdated

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentGroup": {
      "namespace": "string",
      "groupId": "string",
      "name": "string",
      "userId": "string",
      "contents": [
        "string"
      ],
      "createdTime": "2019-08-24T14:15:22Z"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentGroup	ugcContentGroup	-

ugcContentGroupDeleted

Contains fields from event and the following payload.

Example value

{
  "payload": {
    "ugcContentGroup": {
      "namespace": "string",
      "groupId": "string",
      "name": "string",
      "userId": "string",
      "contents": [
        "string"
      ],
      "createdTime": "2019-08-24T14:15:22Z"
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

payload

Name	Type	Description
ugcContentGroup	ugcContentGroup	-

Schemas

ugcContent

Name	Type	Description
contentId	string	-
namespace	string	-
channel	string	-
userId	string	-
createdTime	string (date-time)	-
isOfficial	boolean	-
updatedTime	string (date-time)	-
tags	array	-

ugcContentHide

Name	Type	Description
namespace	string	-
contentId	string	-
userId	string	-
autoModeration	boolean	-

ugcContentLike

Name	Type	Description
namespace	string	-
userId	string	-
creatorId	string	-
contentId	string	-

ugcChannel

Name	Type	Description
namespace	string	-
channelId	string	-
userId	string	-
channelName	string	-

ugcCreator

Name	Type	Description
namespace	string	-
userId	string	-
creatorId	string	-

ugcCreatorBan

Name	Type	Description
namespace	string	-
userId	string	-
reason	string	-
type	string	-
enable	boolean	-
endDate	string (date-time)	-

ugcContentGroup

Name	Type	Description
namespace	string	-
groupId	string	-
name	string	-
userId	string	-
contents	array	-
createdTime	string (date-time)	-

event

Name	Type	Description
id	string	-
version	integer	-
name	string	-
namespace	string	-
parentNamespace	string	-
timestamp	string (date-time)	-
clientId	string	-
userId	string	-
traceId	string	-
sessionId	string	-

UGC Service Events 0.1.0 documentation

Published Messages (ugcContent)​

ugcContentUpdated​

payload​

ugcContentDeleted​

payload​

payload.ugcContentDelete​

ugcContentHide​

payload​

ugcContentUnHide​

payload​

ugcContentCreated​

payload​

ugcContentLiked​

payload​

ugcContentUnLiked​

payload​

Published Messages (ugcChannel)​

ugcChannelCreated​

payload​

ugcChannelUpdated​

payload​

ugcChannelDeleted​

payload​

payload.ugcChannel​

Published Messages (ugcCreator)​

ugcCreatorCreated​

payload​

ugcCreatorFollowed​

payload​

ugcCreatorUnFollowed​

payload​

ugcCreatorDeleted​

payload​

ugcCreatorBanned​

payload​

ugcCreatorUnBanned​

payload​

Published Messages (ugcContentGroup)​

ugcContentGroupCreated​

payload​

ugcContentGroupUpdated​

payload​

ugcContentGroupDeleted​

payload​

Schemas​

ugcContent​

ugcContentHide​

ugcContentLike​

ugcChannel​

ugcCreator​

ugcCreatorBan​

ugcContentGroup​

event​

On this page

Published Messages (ugcContent)

ugcContentUpdated

payload

ugcContentDeleted

payload

payload.ugcContentDelete

ugcContentHide

payload

ugcContentUnHide

payload

ugcContentCreated

payload

ugcContentLiked

payload

ugcContentUnLiked

payload

Published Messages (ugcChannel)

ugcChannelCreated

payload

ugcChannelUpdated

payload

ugcChannelDeleted

payload

payload.ugcChannel

Published Messages (ugcCreator)

ugcCreatorCreated

payload

ugcCreatorFollowed

payload

ugcCreatorUnFollowed

payload

ugcCreatorDeleted

payload

ugcCreatorBanned

payload

ugcCreatorUnBanned

payload

Published Messages (ugcContentGroup)

ugcContentGroupCreated

payload

ugcContentGroupUpdated

payload

ugcContentGroupDeleted

payload

Schemas

ugcContent

ugcContentHide

ugcContentLike

ugcChannel

ugcCreator

ugcCreatorBan

ugcContentGroup

event