nick

Documentation

Index

• Variables
• func Delete(person, place int64) error
• func ParsePerson(m *core.Message, place int64, s string) (int64, error)
• func ParsePersonHere(m *core.Message, s string) (int64, error)
• func Set(nick string, person, place int64) (error, error)
• func Show(person, place int64) (string, error, error)

Variables

var (
	ErrPersonNotFound = errors.New("You have not set a nickname.")
	ErrNickExists     = errors.New("Nickname is already in use either by you or someone else.")
)

var Admin = admin{}

var AdminDelete = adminDelete{}

var AdminSet = adminSet{}

var AdminShow = adminShow{}

var Advanced = advanced{}

var AdvancedDelete = advancedDelete{}

var AdvancedSet = advancedSet{}

var AdvancedShow = advancedShow{}

var Normal = normal{}

Functions

func Delete

func Delete(person, place int64) error

Delete deletes the person's nickname in the specified place. If no nickname has been set then returns an ErrPersonNotFound error.

func ParsePerson

func ParsePerson(m *core.Message, place int64, s string) (int64, error)

Tries to find a person from the given string. If "me" is passed the author is returned. Then tries to match a nickname and if it fails it tries various platform specific things (checking if the string is a mention of some sort, etc.)

func ParsePersonHere

func ParsePersonHere(m *core.Message, s string) (int64, error)

Same as ParsePerson but uses the default place instead

func Set

func Set(nick string, person, place int64) (error, error)

Set sets the person's nickname in the specified place. If the nickname already exists in that place then it returns an ErrNickExists error.

func Show

func Show(person, place int64) (string, error, error)

Show returns the person's nickname in the specified place. If no nickname has been set then returns an ErrPersonNotFound error.