models

Documentation

Index

• Constants
• type Subscription
• type ThreadSubscriptionsRecord
  • func NewThreadSubscriptionsRecord() (tsr *ThreadSubscriptionsRecord)
  • func NewThreadSubscriptionsRecordArrayFromRows(rows base.IScannableSequence) (tsrs []ThreadSubscriptionsRecord, err error)
  • func NewThreadSubscriptionsRecordFromScannableSource(src base.IScannable) (tsr *ThreadSubscriptionsRecord, err error)
• type UserSubscriptions
  • func NewUserSubscriptions(userId base2.Id, allThreadIds *ul.UidList, pageNumber base2.Count, ...) (us *UserSubscriptions)
• type UserSubscriptionsRecord
  • func NewUserSubscriptionsRecord() (usr *UserSubscriptionsRecord)
  • func NewUserSubscriptionsRecordArrayFromRows(rows base.IScannableSequence) (usrs []UserSubscriptionsRecord, err error)
  • func NewUserSubscriptionsRecordFromScannableSource(src base.IScannable) (usr *UserSubscriptionsRecord, err error)

Constants

const (
	IdForVirtualUserSubscriptionsRecord = -1
)

Types

type Subscription

type Subscription struct {
	// ID of a thread to which a user is subscribed.
	ThreadId cmb.Id `json:"threadId"`

	// ID of a subscribed user.
	UserId cmb.Id `json:"userId"`
}

type ThreadSubscriptionsRecord

type ThreadSubscriptionsRecord struct {
	Id       cmb.Id      `json:"id"`
	ThreadId cmb.Id      `json:"threadId"`
	Users    *ul.UidList `json:"userIds"`
}

func NewThreadSubscriptionsRecord

func NewThreadSubscriptionsRecord() (tsr *ThreadSubscriptionsRecord)

func NewThreadSubscriptionsRecordArrayFromRows

func NewThreadSubscriptionsRecordArrayFromRows(rows base.IScannableSequence) (tsrs []ThreadSubscriptionsRecord, err error)

func NewThreadSubscriptionsRecordFromScannableSource

func NewThreadSubscriptionsRecordFromScannableSource(src base.IScannable) (tsr *ThreadSubscriptionsRecord, err error)

type UserSubscriptions

type UserSubscriptions struct {

	// Subscriber is an ID of a user. This is equivalent to UserId.
	Subscriber base2.Id `json:"subscriber"`

	// Subscriptions is an array of IDs of threads to which a user is
	// subscribed. This is equivalent to ThreadIds.
	Subscriptions []base2.Id `json:"subscriptions"`

	PageData *cmr.PageData `json:"pageData,omitempty"`
}

func NewUserSubscriptions

func NewUserSubscriptions(userId base2.Id, allThreadIds *ul.UidList, pageNumber base2.Count, pageSize base2.Count) (us *UserSubscriptions)

NewUserSubscriptions is a constructor of UserSubscriptions. When pagination is not needed, pag number must be zero. When page number is positive, pagination is enabled.

type UserSubscriptionsRecord

type UserSubscriptionsRecord struct {
	Id      cmb.Id      `json:"id"`
	UserId  cmb.Id      `json:"userId"`
	Threads *ul.UidList `json:"threadIds"`
}

func NewUserSubscriptionsRecord

func NewUserSubscriptionsRecord() (usr *UserSubscriptionsRecord)

func NewUserSubscriptionsRecordArrayFromRows

func NewUserSubscriptionsRecordArrayFromRows(rows base.IScannableSequence) (usrs []UserSubscriptionsRecord, err error)

func NewUserSubscriptionsRecordFromScannableSource

func NewUserSubscriptionsRecordFromScannableSource(src base.IScannable) (usr *UserSubscriptionsRecord, err error)