userutil

Documentation

Index

• func MakeUserID(localpart string, server spec.ServerName) string
• func ParseUsernameParam(usernameParam string, cfg *config.Global) (string, spec.ServerName, error)
• type AnyIdentifier
  • func (i AnyIdentifier) MarshalJSON() ([]byte, error)
  • func (i *AnyIdentifier) UnmarshalJSON(bs []byte) error
• type Identifier
• type IdentifierType
• type Medium
• type PhoneIdentifier
  • func (i *PhoneIdentifier) IdentifierType() IdentifierType
  • func (i *PhoneIdentifier) String() string
• type ThirdPartyIdentifier
  • func (i *ThirdPartyIdentifier) IdentifierType() IdentifierType
  • func (i *ThirdPartyIdentifier) String() string
• type UnknownIdentifier
  • func (i *UnknownIdentifier) IdentifierType() IdentifierType
  • func (i *UnknownIdentifier) String() string
• type UserIdentifier
  • func (i *UserIdentifier) IdentifierType() IdentifierType
  • func (i *UserIdentifier) String() string

Functions

func MakeUserID

func MakeUserID(localpart string, server spec.ServerName) string

MakeUserID generates user ID from localpart & server name

func ParseUsernameParam

func ParseUsernameParam(usernameParam string, cfg *config.Global) (string, spec.ServerName, error)

ParseUsernameParam extracts localpart from usernameParam. usernameParam can either be a user ID or just the localpart/username. If serverName is passed, it is verified against the domain obtained from usernameParam (if present) Returns error in case of invalid usernameParam.

Types

type AnyIdentifier

type AnyIdentifier struct {
	Identifier
}

AnyIdentifier is a wrapper that allows marshalling and unmarshalling the various types of identifiers to/from JSON. Always use this in data types that will be used in JSON manipulation.

func (AnyIdentifier) MarshalJSON

func (i AnyIdentifier) MarshalJSON() ([]byte, error)

func (*AnyIdentifier) UnmarshalJSON

func (i *AnyIdentifier) UnmarshalJSON(bs []byte) error

type Identifier

type Identifier interface {
	// IdentifierType returns the identifier type, like "m.id.user".
	IdentifierType() IdentifierType

	// String returns a debug-output string representation. The format
	// is not specified.
	String() string
}

An Identifier identifies a user. There are many kinds, and this is the common interface for them.

If you need to handle an identifier as JSON, use the AnyIdentifier wrapper. Passing around identifiers in code, the raw Identifier is enough.

See https://matrix.org/docs/spec/client_server/r0.6.1#identifier-types

type IdentifierType

type IdentifierType string

IdentifierType describes the type of identifier.

const (
	IdentifierUser       IdentifierType = "m.id.user"
	IdentifierThirdParty IdentifierType = "m.id.thirdparty"
	IdentifierPhone      IdentifierType = "m.id.phone"
)

type Medium

type Medium string

Medium describes the interpretation of a third-party identifier.

const (
	// MediumEmail signifies that the address is an email address.
	MediumEmail Medium = "email"
)

type PhoneIdentifier

type PhoneIdentifier struct {
	// Country is a ISO-3166-1 alpha-2 country code.
	Country string `json:"country"`

	// PhoneNumber is a country-specific phone number, as it would be dialled from.
	PhoneNumber string `json:"phone"`
}

A PhoneIdentifier references a phone number.

func (*PhoneIdentifier) IdentifierType

func (i *PhoneIdentifier) IdentifierType() IdentifierType

func (*PhoneIdentifier) String

func (i *PhoneIdentifier) String() string

type ThirdPartyIdentifier

type ThirdPartyIdentifier struct {
	// Medium is normally MediumEmail.
	Medium Medium `json:"medium"`

	// Address is the medium-specific identifier.
	Address string `json:"address"`
}

A ThirdPartyIdentifier references an identifier in another system.

func (*ThirdPartyIdentifier) IdentifierType

func (i *ThirdPartyIdentifier) IdentifierType() IdentifierType

func (*ThirdPartyIdentifier) String

func (i *ThirdPartyIdentifier) String() string

type UnknownIdentifier

type UnknownIdentifier struct {
	json.RawMessage
	Type IdentifierType
}

UnknownIdentifier is the catch-all for identifiers this code doesn't know about. It simply stores raw JSON.

func (*UnknownIdentifier) IdentifierType

func (i *UnknownIdentifier) IdentifierType() IdentifierType

func (*UnknownIdentifier) String

func (i *UnknownIdentifier) String() string

type UserIdentifier

type UserIdentifier struct {
	UserID string `json:"user"`
}

A UserIdentifier contains an MXID. It may be only the local part.

func (*UserIdentifier) IdentifierType

func (i *UserIdentifier) IdentifierType() IdentifierType

func (*UserIdentifier) String

func (i *UserIdentifier) String() string