Skip to content

Latest commit

 

History

History
182 lines (175 loc) · 5.19 KB

channel.md

File metadata and controls

182 lines (175 loc) · 5.19 KB

Channels

Introduction

Channels are organizational structures for content. This means blocks but also sometimes other channels. Channels have a primary user (indicated by the user_id) but can also have collaborators (an array of users). Channels can be public (anyone can view and add), closed (only the channel's author and collaborators can add but everyone can view) and private (only the channels authors and collaborators can view and add).

Attributes

id (Integer) The internal ID of the channel
title (String) The title of the channel
created_at (Timestamp) Timestamp when the channel was created
updated_at (Timestamp) Timestamp when the channel was last updated
published (Boolean) If channel is visible to all members of Are.na or not
open (Boolean) If channel is open to other members of Are.na for adding blocks
collaboration (Boolean) If the channel has collaborators or not
slug (String) The slug of the channel used in the url (e.g. http://are.na/Are.na-influences)
length (Integer) The number of items in a channel (blocks and other channels)
kind (String) Can be either "default" (a standard channel) or "profile" the default channel of a user
status (String) Can be "private" (only open for reading and adding to the channel by channel author and collaborators), "closed" (open for reading by everyone, only channel author and collaborators can add) or "public" (everyone can read and add to the channel)
user_id (Integer) Internal ID of the channel author
class (String) Will always be "Channel"
base_class (String) Will always be "Channel"
user (Hash) More information on the channel author. Contains id, slug, first_name, last_name, full_name, avatar, email, channel_count, following_count, follower_count, and profile_id
total_pages (Integer) If pagination is used, how many total pages there are in your request
current_page (Integer) If pagination is used, page requested
per (Integer) If pagination is used, items per page requested
follower_count (Integer) Number of followers the channel has
contents (Array, can be null) Array of blocks and other channels in the channel. Note: If the request is authenticated, this will include any private channels included in the requested channel that you have access to. If not, only public channels included in the requested channel will be shown.
collaborators (Array, can be null) Collaborators on the channel

Blocks inside the channel's contents node have attributes that are specific to the channel:

position (Integer) The position of the block inside the channel (as determined by the channel's author and collaborators)
selected (Boolean) Block is marked as selected inside the channel (this is an initial attempt to allow users to "feature" some content over others, can be used for moderation, introduction text, etc)
connected_at (Timestamp) Time when block was connected to the channel (if the block was created at the same time as the channel this will be identical to created_at)
connected_by_user_id (Integer) ID of the user who connected the block to the channel (if the block was not reused by another user, this will be identical to user_id)

Endpoints