Global

Type Definitions

SidechatActivityItem

A single activity item (in-app notification)

Type:

Object

Properties

Name	Type	Attributes	Description
`id`	String		alphanumeric ID of activity item
`type`	String		kind of activity (e.g. "comment", "comment_reply", "votes", "new_follower", "quote", "trending_post")
`text`	String		user-facing description of the activity
`timestamp`	String		date string of when the activity happened
`is_seen`	Boolean		whether or not the user has seen the activity
`post_id`	String	<optional>	alphanumeric ID of related post
`comment_id`	String	<optional>	alphanumeric ID of related comment
`group_id`	String	<optional>	alphanumeric ID of related group
`yakarma`	Number	<optional>	yakarma gained
`username`	String	<optional>	username of the other user involved, if any

Source: types/SidechatTypes.js, line 237

SidechatActivityList

A page of the user's activity

Type:

Object

Properties

Name	Type	Description
`items`	Array.<SidechatActivityItem>	activity items
`cursor`	SidechatCursorString

Source: types/SidechatTypes.js, line 230

SidechatAssetMetadata

An asset object, containing information about an image from the asset library

Type:

Object

Properties

Name	Type	Description
`width`	Number	width of asset
`height`	Number	height of asset
`type`	"image"	undocumented
`content_type`	"jpeg" \| "png" \| "gif"	file type of asset

Source: types/SidechatTypes.js, line 73

SidechatAttachment

A link attachment on a post

Type:

Object

Properties

Name	Type	Attributes	Description
`id`	String		alphanumeric ID of attachment
`type`	"link" \| "youtube"		whether the link is a regular link or a YouTube video
`link_url`	String		URL the attachment points to
`display_url`	String	<optional>	shortened URL for display
`title`	String	<optional>	title of the linked page
`asset`	Object	<optional>	preview image of the linked page

Source: types/SidechatTypes.js, line 205

SidechatAuthToken

A user's bearer authentication token needed for most requests

Type:

String

Source: types/SidechatTypes.js, line 148

SidechatColor

Properties

Name	Type	Description
`primary`	String	hex code of primary color
`secondary`	String	hex code of secondary color

Source: classes/SidechatColorList.js, line 1

SidechatCurrentUser

The current user's information

Type:

Object

Properties

Name	Type	Description
`id`	String	alphanumeric ID of current user
`hashedVerifiedEmail`	String	verified email of current user in an unreadable hashed form
`isGlobalModerator`	Boolean	whether or not user is a moderator
`isGlobalAdmin`	Boolean	whether or not user is an admin
`memberships`	Array.<SidechatMembership>
`roles`	Array	undocumented
`emailDomain`	String	domain of verified email address on account
`wildcardEmailDomain`	String	domain of verified email address on account, preceeded by *. to support subdomains

Source: types/SidechatTypes.js, line 97

SidechatCursorString

A cursor for paginating through post lists

Type:

String

Source: types/SidechatTypes.js, line 138

SidechatDirectMessage

A single direct message

Type:

Object

Properties

Name	Type	Description
`created_at`	String	time at which the message was sent
`client_id`	String	alphanumeric ID of the device the message was sent on
`obfuscatedUserId`	String	obfuscated version of the sender's alphanumeric ID
`text`	String	body text of the message
`id`	String	alphanumeric ID of the message
`chat_id`	String	alphanumeric ID of the thread in which the message resides
`authored_by_user`	Boolean	whether or not the current user sent the message
`type`	"message"	undocumented

Source: types/SidechatTypes.js, line 173

SidechatDirectThread

A direct message thread

Type:

Object

Properties

Name	Type	Description
`id`	String	alphanumeric ID of thread
`group_id`	String	alphanumeric ID of group in which the thread exists
`updated_at`	String	date string of when the last message in the chat was sent
`post_id`	String	post or comment from which the thread was originally sent
`post_context`	String	the context of the DM thread (only "feed" is known at the moment)
`accept_status`	"accepted"	whether or not the other user has accepted this DM
`type`	"post" \| "comment"	the type of the content from which the DM was originally sent
`messages`	Array.<SidechatDirectMessage>	array of direct message objects

Source: types/SidechatTypes.js, line 160

SidechatFeed

A page of the home feed

Type:

Object

Properties

Name	Type	Description
`feed_items`	Array.<SidechatFeedItem>	items in the feed
`cursor`	SidechatCursorString

Source: types/SidechatTypes.js, line 216

SidechatFeedItem

A single item in the home feed

Type:

Object

Properties

Name	Type	Attributes	Description
`item_type`	String		type of item (posts have a type of "post")
`post`	SidechatPostOrComment	<optional>	the post, if this item is a post

Source: types/SidechatTypes.js, line 223

SidechatGroup

A group object, containing metadata about a group as well as its join conditions and states. Some properties vary based on the endpoint the object came from.

Type:

Object

Properties

Name	Type	Attributes	Description
`id`	String		alphanumeric ID of group
`name`	String		human-readable name of group
`analytics_name`	String		name to file group under
`membership_type`	"non_member" \| "member"		whether or not current user is a member of group
`color`	String		group's theme color as hex code (e.g., #FFFFFF)
`group_join_type`	"open" \| "closed" \| "email_domain"		basis on which group accepts new members
`group_visibility`	"private" \| "public_to_all" \| "public_to_schools"		group's visibility setting
`asset_library_visibility`	"show" \| "hide"		whether or not group's asset library is visible
`roles`	Array	<optional>	undocumented
`description`	String	<optional>	description of group
`icon_url`	SidechatPrivateAssetURL	<optional>	image URL for group icon
`member_count`	Number	<optional>	number of users in group
`should_show_leaderboard`	Boolean	<optional>	undocumented

Source: types/SidechatTypes.js, line 33

SidechatIcon

A conversation icon associated with a user

Type:

Object

Properties

Name	Type	Description
`emoji`	String	unicode emoji character
`color`	String	primary hex color code
`secondary_color`	String	secondary hex color code

Source: types/SidechatTypes.js, line 89

SidechatIdentity

A user's anonymous identity information

Type:

Object

Properties

Name	Type	Description
`name`	String	representation of user's name (varies across app)
`posted_with_username`	Boolean	undocumented

Source: types/SidechatTypes.js, line 82

SidechatKarma

A user's karma within a group

Type:

Object

Properties

Name	Type	Description
`group_id`	String	alphanumeric ID of group
`post`	Number	karma from posts
`comment`	Number	karma from comments
`yakarma`	Number	total karma

Source: types/SidechatTypes.js, line 262

SidechatLeaderboard

A group leaderboard and the current user's place in it

Type:

Object

Properties

Name	Type	Description
`leaderboard`	Array.<{value: Number}>	all-time leaderboard entries
`season_leaderboard`	Array.<{value: Number}>	leaderboard entries for the current season
`season`	Object	the current season
`karma`	SidechatKarma	current user's all-time karma in the group
`season_karma`	SidechatKarma	current user's karma this season

Source: types/SidechatTypes.js, line 252

SidechatLibraryAsset

An asset object, containing information about an image from the asset library

Type:

Object

Properties

Name	Type	Description
`id`	String	alphanumeric ID of asset
`created_at`	String	date string of asset creation time
`metadata`	SidechatAssetMetadata	metadata associated with asset
`url`	SidechatPrivateAssetURL	URL string of asset's location

Source: types/SidechatTypes.js, line 64

SidechatMembership

Representation of a group membership

Type:

Object

Properties

Name	Type	Description
`groupId`	String	alphanumeric ID of group
`type`	String	role of current user in group

Source: types/SidechatTypes.js, line 126

SidechatNotificationPreferences

Which push notifications a user receives

Type:

Object

Properties

Name	Type	Attributes	Description
`chats`	Boolean	<optional>	direct messages
`followed_posts_activity`	Boolean	<optional>	new comments on followed posts
`new_followers`	Boolean	<optional>	new followers
`post_activity`	Boolean	<optional>	comments and votes on the user's own posts
`trending`	Boolean	<optional>	trending posts
`community_activity`	Boolean	<optional>	undocumented
`leaderboards`	Boolean	<optional>	leaderboard updates
`rewards`	Boolean	<optional>	undocumented
`feature_updates`	Boolean	<optional>	announcements about new features
`yak_ball_updates`	Boolean	<optional>	undocumented
`game_reminders`	Boolean	<optional>	undocumented
`daily_game_reminders`	Boolean	<optional>	undocumented
`game_invitations`	Boolean	<optional>	undocumented
`game_match_updates`	Boolean	<optional>	undocumented

Source: types/SidechatTypes.js, line 271

SidechatPoll

Represents a poll with choices

Type:

Object

Properties

Name	Type	Description
`id`	String	alphanumeric ID of poll
`post_id`	String	alphanumeric ID of post to which poll is attached
`choices`	Array.<SidechatPollChoice>	array of poll choices
`allows_view_results`	Boolean	whether or not poll results are publicly visible
`view_results_count`	Number	number of users who have viewed poll results
`participated`	Boolean	whether or not current user has voted in poll

Source: types/SidechatTypes.js, line 186

SidechatPollChoice

Represents a poll choice

Type:

Object

Properties

Name	Type	Description
`count`	Number	number of votes for choice
`text`	String	user-visible text of choice
`selected`	Boolean	whether or not current user has voted for choice

Source: types/SidechatTypes.js, line 197

SidechatPostOrComment

A user-created post or comment, depending on the "type" prop

Type:

Object

Properties

Name	Type	Attributes	Description
`type`	"post" \| "comment"		whether this object represents a post or a comment on a post
`id`	String		alphanumeric ID of post or comment
`authored_by_user`	Boolean		whether or not the post or comment was created by the current user
`alias`	String		post creator's name in-app
`group_id`	String		alphanumeric ID of group
`group`	SidechatGroup		group in which post or comment was created
`text`	String		text content of post or comment
`created_at`	String		date string of post or comment creation time
`vote_total`	Number		sum of upvotes and downvotes
`vote_status`	SidechatVoteString		current user's vote on post or comment
`assets`	Array.<SidechatSimpleAsset>		array of simple assets attached to post or comment
`attachments`	Array.<SidechatAttachment>		link attachments on the post
`dms_disabled`	Boolean		whether or not you can send a DM to creator of post
`tags`	Array.<String>		undocumented
`identity`	SidechatIdentity		creator's identity information
`pinned`	Boolean		undocumented
`is_saved`	Boolean		whether or not the current user has saved the post
`follow_status`	"following" \| "following_commented" \| "not_following"		whether or not the current user should recieve activity notifications for the post
`destination`	"group" \| "account"	<optional>	whether the post was made in a group or on the author's profile
`is_deleted`	Boolean	<optional>	whether or not the post or comment has been deleted
`quote_post`	Object	<optional>	the post being quoted, if this is a repost
`comment_count`	Number	<optional>	number of comments on post (only if type=post)
`comments_disabled`	Boolean	<optional>	whether or not you can comment on post (only if type=post)
`poll`	SidechatPoll	<optional>	poll attached to post (only if the post has a poll)
`parent_post_id`	String	<optional>	alphanumeric ID of parent post (only if type=comment)
`reply_post_id`	String	<optional>	alphanumeric ID of comment being replied to, falls back to parent_post_id (only if type=comment)
`context`	String	<optional>	text content of comment being replied to, falls back to text (only if type=comment)

Source: types/SidechatTypes.js, line 1

SidechatPostsAndCursor

A list of posts and the associated cursor

Type:

Object

Properties

Name	Type	Description
`posts`	Array.<SidechatPostOrComment>
`cursor`	SidechatCursorString

Source: types/SidechatTypes.js, line 153

SidechatPrivateAssetURL

An asset URL that can only be accessed by making a request with a user's bearer token attached in the Authorization header

Type:

String

Source: types/SidechatTypes.js, line 133

SidechatProfile

A user's public profile

Type:

Object

Properties

Name	Type	Description
`id`	String	alphanumeric ID of user
`name`	String	public-facing username
`conversation_icon`	SidechatIcon	icon associated with user
`description`	Boolean	the user bio
`index_name`	String	undocumented
`analytics_name`	String	undocumented
`color`	String	undocumented
`share_color_start`	String	undocumented
`share_color_end`	String	undocumented
`group_join_type`	"account"	undocumented
`group_visibility`	"public_to_all"	the profile visibility status

Source: types/SidechatTypes.js, line 110

SidechatReportReason

A reason for reporting a post, comment, or direct message thread

Type:

"username" | "spam" | "offTopic" | "pii" | "selfHarmDangerousActs" | "illegalActivities" | "offensiveHateSpeech" | "harassmentBullying" | "minorSafety" | "sexualContent" | "violentGraphicContent" | "misinformation" | "other"

Source: types/SidechatTypes.js, line 289

SidechatSimpleAsset

An asset object, containing information about an image within a post or comment

Type:

Object

Properties

Name	Type	Attributes	Description
`id`	String		alphanumeric ID of asset
`type`	"image" \| "video"		whether the asset is an image or a video
`content_type`	"jpeg" \| "png" \| "gif" \| "webp" \| "mp4" \| "mov"		file type of asset
`width`	Number		width of asset
`height`	Number		height of asset
`url`	SidechatPrivateAssetURL	<optional>	URL string of asset's location (an HLS .m3u8 stream for processed videos)
`thumbnail_asset`	SidechatSimpleAsset	<optional>	preview image (only if type=video)
`vod_status`	"not_started" \| "ingest" \| "complete" \| "error"	<optional>	processing status (only if type=video)

Source: types/SidechatTypes.js, line 51

SidechatVoteString

A vote on a comment or post

Type:

"upvote" | "downvote" | "none"

Source: types/SidechatTypes.js, line 143