profiles

package

v1.20.0 Latest Latest Go to latest Published: Nov 7, 2022 License: GPL-3.0 Imports: 21 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/signal-golang/textsecure

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func GenerateProfileKey() []byte
func GetLocalAvatar(uuid string) (io.ReadCloser, error)
func GetLocalAvatarPath(uuid string) (string, error)
func GetProfileE164(tel string) (contacts.Contact, error)
func GetRemoteAvatar(avatarURL string) (io.ReadCloser, error)
func SaveAvatar(uuid string, avatar []byte) error
func UpdateProfile(profileKey []byte, uuid, name string) error
type Profile
type ProfileSettings

Constants ¶

View Source

const (
	PROFILE_PATH            = "/v1/profile/%s"
	PROFILE_CREDENTIAL_PATH = "/v1/profile/%s/%s/%s"
	PROFILE_USERNAME_PATH   = "/v1/profile/username/%s"

	NAME_PADDED_LENGTH = 53
)

View Source

const NONCE_LEN = 12

Variables ¶

This section is empty.

Functions ¶

func GenerateProfileKey ¶

func GenerateProfileKey() []byte

GenerateProfileKey generates a new ProfileKey

func GetLocalAvatar ¶ added in v1.15.0

func GetLocalAvatar(uuid string) (io.ReadCloser, error)

func GetLocalAvatarPath ¶ added in v1.15.0

func GetLocalAvatarPath(uuid string) (string, error)

func GetProfileE164 ¶

func GetProfileE164(tel string) (contacts.Contact, error)

GetProfileE164 get a profile by a phone number

func GetRemoteAvatar ¶ added in v1.12.0

func GetRemoteAvatar(avatarURL string) (io.ReadCloser, error)

GetAvatar returns an avatar for it's url from signal cdn

func SaveAvatar ¶ added in v1.12.0

func SaveAvatar(uuid string, avatar []byte) error

func UpdateProfile ¶

func UpdateProfile(profileKey []byte, uuid, name string) error

UpdateProfile ...

Types ¶

type Profile ¶

type Profile struct {
	IdentityKey                    string                     `json:"identityKey"`
	UnidentifiedAccess             string                     `json:"unidentifiedAccess"`
	UnrestrictedUnidentifiedAccess bool                       `json:"unrestrictedUnidentifiedAccess"`
	Capabilities                   config.AccountCapabilities `json:"capabilities"`
	Badges                         []string                   `json:"badges"`
	UUID                           string                     `json:"uuid"`
	Name                           string                     `json:"name"`
	About                          string                     `json:"about"`
	AboutEmoji                     string                     `json:"aboutEmoji"`
	Avatar                         string                     `json:"avatar"`
	PaymentAddress                 string                     `json:"paymentAddress"`
	Credential                     []byte                     `json:"credential"`
}

Profile describes the profile type

func GetProfile ¶

func GetProfile(UUID string, profileKey []byte) (*Profile, error)

func GetProfileAndCredential ¶ added in v1.6.0

func GetProfileAndCredential(UUID string, profileKey []byte) (*Profile, error)

func GetProfileUUID ¶ added in v1.12.0

func GetProfileUUID(uuid string) (*Profile, error)

GetProfileUUID get a profile by a phone number

type ProfileSettings ¶

type ProfileSettings struct {
	Version    string `json:"version"`
	Name       []byte `json:"name"`
	About      []byte `json:"about"`
	AboutEmoji []byte `json:"aboutEmoji"`

	Avatar     bool     `json:"avatar"`
	Commitment []byte   `json:"commitment"`
	BadgeIds   []string `json:"badgeIds"`
	// contains filtered or unexported fields
}

Profile ...

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL