assets

Documentation

Index

• type AssetSource
• type Channel
• type ChannelRole
• type ChannelUUID
• type Field
• type FieldType
• type Flow
• type FlowUUID
• type Group
• type GroupUUID
• type Label
• type LabelUUID
• type LocationHierarchy
• type Resthook

Types

type AssetSource

type AssetSource interface {
	Channels() ([]Channel, error)
	Fields() ([]Field, error)
	Flow(FlowUUID) (Flow, error)
	Groups() ([]Group, error)
	Labels() ([]Label, error)
	Locations() ([]LocationHierarchy, error)
	Resthooks() ([]Resthook, error)
}

AssetSource is a source of assets

type Channel

type Channel interface {
	UUID() ChannelUUID
	Name() string
	Address() string
	Schemes() []string
	Roles() []ChannelRole
	ParentUUID() ChannelUUID
	Country() string
	MatchPrefixes() []string
}

Channel is something that can send/receive messages

type ChannelRole

type ChannelRole string

ChannelRole is a role that a channel can perform

const (
	ChannelRoleSend    ChannelRole = "send"
	ChannelRoleReceive ChannelRole = "receive"
	ChannelRoleCall    ChannelRole = "call"
	ChannelRoleAnswer  ChannelRole = "answer"
	ChannelRoleUSSD    ChannelRole = "ussd"
)

different roles that channels can perform

type ChannelUUID

type ChannelUUID utils.UUID

ChannelUUID is the UUID of a channel

const NilChannelUUID ChannelUUID = ChannelUUID("")

NilChannelUUID is an empty channel UUID

type Field

type Field interface {
	Key() string
	Name() string
	Type() FieldType
}

Field is a custom contact property

type FieldType

type FieldType string

FieldType is the data type of values for each field

const (
	FieldTypeText     FieldType = "text"
	FieldTypeNumber   FieldType = "number"
	FieldTypeDatetime FieldType = "datetime"
	FieldTypeWard     FieldType = "ward"
	FieldTypeDistrict FieldType = "district"
	FieldTypeState    FieldType = "state"
)

field value types

type Flow

type Flow interface {
	UUID() FlowUUID
	Name() string
	Definition() json.RawMessage
}

Flow is graph of nodes with actions and routers

type FlowUUID

type FlowUUID utils.UUID

FlowUUID is the UUID of a flow

type Group

type Group interface {
	UUID() GroupUUID
	Name() string
	Query() string
}

Group is a set of contacts

type GroupUUID

type GroupUUID utils.UUID

GroupUUID is the UUID of a group

type Label

type Label interface {
	UUID() LabelUUID
	Name() string
}

Label is something that can be applied a message

type LabelUUID

type LabelUUID utils.UUID

LabelUUID is the UUID of a label

type LocationHierarchy

type LocationHierarchy interface {
	FindByPath(path string) *utils.Location
	FindByName(name string, level utils.LocationLevel, parent *utils.Location) []*utils.Location
}

LocationHierarchy is a searchable hierachy of locations

type Resthook

type Resthook interface {
	Slug() string
	Subscribers() []string
}

Resthook is a set of URLs which are subscribed to the named event