compose

Documentation

Index

• Constants
• Variables
• func Contacts(limit int) turnpike.Call
• func CreateChannel(kind ChannelType, id, title, description, coverURL string, invitedIDs []string) turnpike.Call
• func DMChannelName(self string, them []string) string
• func EventsIn(channel string) turnpike.Subscribe
• func ExitChannel(channel string) turnpike.Call
• func GetChannel(channel string) turnpike.Call
• func GetDMChannel(id string, them ...string) turnpike.Call
• func HideChannel(channel string) turnpike.Call
• func Invite(channel string, users []string) turnpike.Call
• func InviteResponse(channel string, accept bool) turnpike.Call
• func JoinChannel(channel string) turnpike.Call
• func JoinedChannels(id string) turnpike.Subscribe
• func Kick(channel, user string) turnpike.Call
• func ListMessages(channel string, limit int, page Page[int]) turnpike.Call
• func MessageTo(channel, text string) turnpike.Publish
• func NewChannel(title, name, description string, invite []string, channelType ChannelType) turnpike.Call
• func Operators(channel string) turnpike.Call
• func ReceiveInvite(id string) turnpike.Subscribe
• func SearchContacts(query string, limit int) turnpike.Call
• func URI(name string) turnpike.URI
• type ChannelJoinState
• type ChannelRole
• type ChannelType
• type Page
  • func Next[T int | string](value T) Page[T]
  • func NoPage[T int | string]() Page[T]
  • func Prev[T int | string](value T) Page[T]
• type Request
  • func ChatsQuery(query string, limit int, page Page[string]) Request
  • func Comments(id string, limit int, page Page[string]) Request
  • func ContentByID(id string) Request
  • func Explore(id string, limit int, page Page[string]) Request
  • func Feed(feed string, limit int, page Page[string]) Request
  • func Timeline(id string, limit int, page Page[string]) Request
  • func UserAccount() Request
  • func UserByID(id string) Request
  • func UserByNick(nick string) Request

Constants

const (
	NONE pageDirection = ""
	NEXT pageDirection = "next"
	PREV pageDirection = "prev"
)

Variables

var (
	ChatsTrending = Request{Method: "GET", Path: "/chats/trending"}
)

Functions

func Contacts

func Contacts(limit int) turnpike.Call

call out to get chat contacts

func CreateChannel

func CreateChannel(kind ChannelType, id, title, description, coverURL string, invitedIDs []string) turnpike.Call

func DMChannelName

func DMChannelName(self string, them []string) string

func EventsIn

func EventsIn(channel string) turnpike.Subscribe

subscribe to events happening in a channel

func ExitChannel

func ExitChannel(channel string) turnpike.Call

func GetChannel

func GetChannel(channel string) turnpike.Call

func GetDMChannel

func GetDMChannel(id string, them ...string) turnpike.Call

func HideChannel

func HideChannel(channel string) turnpike.Call

func Invite

func Invite(channel string, users []string) turnpike.Call

func InviteResponse

func InviteResponse(channel string, accept bool) turnpike.Call

func JoinChannel

func JoinChannel(channel string) turnpike.Call

func JoinedChannels

func JoinedChannels(id string) turnpike.Subscribe

func Kick

func Kick(channel, user string) turnpike.Call

func ListMessages

func ListMessages(channel string, limit int, page Page[int]) turnpike.Call

func MessageTo

func MessageTo(channel, text string) turnpike.Publish

publish a text message to a channel

func NewChannel

func NewChannel(title, name, description string, invite []string, channelType ChannelType) turnpike.Call

func Operators

func Operators(channel string) turnpike.Call

func ReceiveInvite

func ReceiveInvite(id string) turnpike.Subscribe

func SearchContacts

func SearchContacts(query string, limit int) turnpike.Call

func URI

func URI(name string) turnpike.URI

Types

type ChannelJoinState

type ChannelJoinState int

const (
	NotJoined ChannelJoinState = 0
	Invited   ChannelJoinState = 1
	Joined    ChannelJoinState = 2
)

type ChannelRole

type ChannelRole int

const (
	RoleDM     ChannelRole = 0 // ?
	RoleNormie ChannelRole = 2 // ???
)

type ChannelType

type ChannelType int

const (
	ChannelDM      ChannelType = 1
	ChannelPrivate ChannelType = 2
	ChannelPublic  ChannelType = 3
)

type Page

type Page[T int | string] struct {
	Key   pageDirection
	Value T
}

func Next

func Next[T int | string](value T) Page[T]

func NoPage

func NoPage[T int | string]() Page[T]

func Prev

func Prev[T int | string](value T) Page[T]

type Request

type Request struct {
	Method, Path string
	Body         io.Reader
	Query        url.Values
}

func ChatsQuery

func ChatsQuery(query string, limit int, page Page[string]) Request

func Comments

func Comments(id string, limit int, page Page[string]) Request

func ContentByID

func ContentByID(id string) Request

func Explore

func Explore(id string, limit int, page Page[string]) Request

content_top_today content_top_this_week content_top_year_{2024..2018} content_top_month_{january..december} content_top_overall content_top_by_share content_shuffle

channel-wtf channel-animals channel-games channel-comic channel-video channel-sports channel-ifunny-originals channel-wholesome-wednesday

category-animals-nature category-anime-manga category-art-creative category-cars category-celebrities category-gaming category-girls category-internet category-memes category-movies category-other category-politics category-science-tech

users_top_by_featured users_top_by_subscribers users_top_by_content_views users_top_overall

chats_popular_last_week chats_new_chats chats_top_by_members

func Feed

func Feed(feed string, limit int, page Page[string]) Request

func Timeline

func Timeline(id string, limit int, page Page[string]) Request

func UserAccount

func UserAccount() Request

func UserByID

func UserByID(id string) Request

func UserByNick

func UserByNick(nick string) Request