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) 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(value int64) Page
  • func NoPage() Page
  • func Prev(value int64) Page
• type Request
  • func ChatsQuery(query string, limit int, page SPage) Request
  • func FeedCollective(prev, next string) Request
  • func FeedFeatures(prev, next string) Request
  • func FeedHome(prev, next string) Request
  • func UserAccount() Request
  • func UserByID(id string) Request
  • func UserByNick(nick string) Request
  • func UserTimelineByID(id, prev, next string) Request
  • func UserTimelineByNick(nick, prev, next string) Request
• type SPage

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) 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 struct {
	Key   pageDirection
	Value int64
}

func Next

func Next(value int64) Page

func NoPage

func NoPage() Page

func Prev

func Prev(value int64) Page

type Request

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

func ChatsQuery

func ChatsQuery(query string, limit int, page SPage) Request

func FeedCollective

func FeedCollective(prev, next string) Request

func FeedFeatures

func FeedFeatures(prev, next string) Request

func FeedHome

func FeedHome(prev, next string) Request

func UserAccount

func UserAccount() Request

func UserByID

func UserByID(id string) Request

func UserByNick

func UserByNick(nick string) Request

func UserTimelineByID

func UserTimelineByID(id, prev, next string) Request

func UserTimelineByNick

func UserTimelineByNick(nick, prev, next string) Request

type SPage

type SPage struct {
	Key   pageDirection
	Value string
}