Source
This page was generated with Wiki Builder. Do not change the format!
Info
Schema
- Schema Type: Class
- Type: object
Properties
| Name | Type | Description |
|---|---|---|
| contentId | integer:int64 | |
| cType | string | |
| cmsPath | string | |
| creationDate | string:date-time | |
| modifyDate | string:date-time | |
| allowComments | boolean | |
| hasAgeGate | boolean | |
| minimumAge | integer:int32 | |
| ratingImagePath | string | |
| author | GeneralUser | |
| autoEnglishPropertyFallback | boolean | |
| properties | Dictionary<string,object> | Firehose content is really a collection of metadata and "properties", which are the potentially-but-not-strictly localizable data that comprises the meat of whatever content is being shown. As Cole Porter would have crooned, "Anything Goes" with Firehose properties. They are most often strings, but they can theoretically be anything. They are JSON encoded, and could be JSON structures, simple strings, numbers etc... The Content Type of the item (cType) will describe the properties, and thus how they ought to be deserialized. |
| representations | ContentRepresentation[] | |
| tags | string[] | |
| commentSummary | CommentSummary |
Example
{
// Type: integer:int64
"contentId": 0,
// Type: string
"cType": "",
// Type: string
"cmsPath": "",
// Type: string:date-time
"creationDate": "",
// Type: string:date-time
"modifyDate": "",
// Type: boolean
"allowComments": false,
// Type: boolean
"hasAgeGate": false,
// Type: integer:int32
"minimumAge": 0,
// Type: string
"ratingImagePath": "",
// Type: GeneralUser
"author": {
// Type: integer:int64
"membershipId": 0,
// Type: string
"uniqueName": "",
// Type: string
"normalizedName": "",
// Type: string
"displayName": "",
// Type: integer:int32
"profilePicture": 0,
// Type: integer:int32
"profileTheme": 0,
// Type: integer:int32
"userTitle": 0,
// Type: integer:int64
"successMessageFlags": 0,
// Type: boolean
"isDeleted": false,
// Type: string
"about": "",
// Type: string:date-time:nullable
"firstAccess": "",
// Type: string:date-time:nullable
"lastUpdate": "",
// Type: integer:int64:nullable
"legacyPortalUID": 0,
// Type: UserToUserContext
"context": {
// Type: boolean
"isFollowing": false,
// Type: IgnoreResponse
"ignoreStatus": {
// Type: boolean
"isIgnored": false,
// Type: IgnoreStatus:Enum
"ignoreFlags": 0
},
// Type: string:date-time:nullable
"globalIgnoreEndDate": ""
},
// Type: string
"psnDisplayName": "",
// Type: string
"xboxDisplayName": "",
// Type: string
"fbDisplayName": "",
// Type: boolean:nullable
"showActivity": false,
// Type: string
"locale": "",
// Type: boolean
"localeInheritDefault": false,
// Type: integer:int64:nullable
"lastBanReportId": 0,
// Type: boolean
"showGroupMessaging": false,
// Type: string
"profilePicturePath": "",
// Type: string
"profilePictureWidePath": "",
// Type: string
"profileThemeName": "",
// Type: string
"userTitleDisplay": "",
// Type: string
"statusText": "",
// Type: string:date-time
"statusDate": "",
// Type: string:date-time:nullable
"profileBanExpire": "",
// Type: string
"blizzardDisplayName": ""
},
// Type: boolean
"autoEnglishPropertyFallback": false,
// Type: Dictionary<string,object>
"properties": {
"{string}": {}
},
// Type: ContentRepresentation[]
"representations": [
// Type: ContentRepresentation
{
// Type: string
"name": "",
// Type: string
"path": "",
// Type: string
"validationString": ""
}
],
// Type: string[]
"tags": [
// Type: string
""
],
// Type: CommentSummary
"commentSummary": {
// Type: integer:int64
"topicId": 0,
// Type: integer:int32
"commentCount": 0
}
}