models

Documentation

Overview

Package models holds generated struct for Account.

Package models holds generated struct for FacebookFriends.

Package models holds generated struct for FacebookProfile.

Package models holds generated struct for MarkAsRequest.

Package models holds generated struct for Profile.

Index

• Variables
• type Account
  • func NewAccount() *Account
  • func (a *Account) Validate() error
• type FacebookFriends
  • func NewFacebookFriends() *FacebookFriends
  • func (f *FacebookFriends) Validate() error
• type FacebookProfile
  • func NewFacebookProfile() *FacebookProfile
  • func (f *FacebookProfile) Validate() error
• type MarkAsRequest
  • func NewMarkAsRequest() *MarkAsRequest
  • func (m *MarkAsRequest) Validate() error
• type Profile
  • func NewProfile() *Profile
  • func (p *Profile) Validate() error

Variables

var AccountEmailStatusConstant = struct {
	Verified    string
	NotVerified string
}{
	Verified:    "verified",
	NotVerified: "notVerified",
}

AccountEmailStatusConstant holds the predefined enums

var AccountStatusConstant = struct {
	Registered string
	Disabled   string
	Spam       string
}{
	Registered: "registered",
	Disabled:   "disabled",
	Spam:       "spam",
}

AccountStatusConstant holds the predefined enums

Types

type Account

type Account struct {
	// The unique identifier for a Account
	ID int64 `json:"id,omitempty,string"`
	// The unique identifier for a Account's Profile
	ProfileID int64 `json:"profileId,string"`
	// Unique ID for facebook.com
	FacebookID string `json:"facebookId"`
	// Access token for facebook.com
	FacebookAccessToken string `json:"facebookAccessToken"`
	// Secret token for facebook.com
	FacebookSecretToken string `json:"facebookSecretToken"`
	// Email Address of the Account
	EmailAddress string `json:"emailAddress"`
	// Status of the Account's Email
	EmailStatusConstant string `json:"emailStatusConstant"`
	// Status of the Account
	StatusConstant string `json:"statusConstant,omitempty"`
	// Account's creation time
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// Account's last update time
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// Account's deletion time
	DeletedAt time.Time `json:"deletedAt,omitempty"`
}

Account represents a registered User

func NewAccount

func NewAccount() *Account

NewAccount creates a new Account struct with default values

func (*Account) Validate

func (a *Account) Validate() error

Validate validates the Account struct

type FacebookFriends

type FacebookFriends struct {
	// The source unique identifier for a Facebook Profile, smaller one will be
	// source.
	SourceID string `json:"sourceId"`
	// The target unique identifier for a Facebook Profile, bigger one will be
	// target.
	TargetID string `json:"targetId"`
}

Holds Facebook Friendship Status

func NewFacebookFriends

func NewFacebookFriends() *FacebookFriends

NewFacebookFriends creates a new FacebookFriends struct with default values

func (*FacebookFriends) Validate

func (f *FacebookFriends) Validate() error

Validate validates the FacebookFriends struct

type FacebookProfile

type FacebookProfile struct {
	// The unique identifier for a Facebook Profile
	ID string `json:"id"`
	// First name for the Profile
	FirstName string `json:"firstName,omitempty"`
	// Middle name for the Profile. Optional
	MiddleName string `json:"middleName,omitempty"`
	// Last name for the Profile
	LastName string `json:"lastName,omitempty"`
	// Picture URL for the Profile
	PictureURL string `json:"pictureUrl,omitempty"`
}

Holds Facebook Profiles

func NewFacebookProfile

func NewFacebookProfile() *FacebookProfile

NewFacebookProfile creates a new FacebookProfile struct with default values

func (*FacebookProfile) Validate

func (f *FacebookProfile) Validate() error

Validate validates the FacebookProfile struct

type MarkAsRequest

type MarkAsRequest struct {
	// The unique identifier for a Account's Profile
	ID           int64  `json:"id,omitempty,string"`
	TypeConstant string `json:"typeConstant,omitempty"`
}

func NewMarkAsRequest

func NewMarkAsRequest() *MarkAsRequest

NewMarkAsRequest creates a new MarkAsRequest struct with default values

func (*MarkAsRequest) Validate

func (m *MarkAsRequest) Validate() error

Validate validates the MarkAsRequest struct

type Profile

type Profile struct {
	// The unique identifier for a Account's Profile
	ID int64 `json:"_id,string" bson:"_id,string"`
	// Full name associated with the profile. Maximum of 20 characters.
	ScreenName string `json:"screenName"`
	// The city or country describing where the user of the account is located. The
	// contents are not normalized or geocoded in any way. Maximum of 30 characters.
	Location string `json:"location,omitempty"`
	// A description of the user owning the account. Maximum of 160 characters.
	Description string `json:"description,omitempty"`
	// Profile's creation time
	CreatedAt time.Time `json:"createdAt,omitempty"`
	// Profile's last update time
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
	// Profile's deletion time
	DeletedAt time.Time `json:"deletedAt,omitempty"`
}

Profile represents a registered Account's Public Info

func NewProfile

func NewProfile() *Profile

NewProfile creates a new Profile struct with default values

func (*Profile) Validate

func (p *Profile) Validate() error

Validate validates the Profile struct