vrchat

package module

v0.0.0-...-cff7185 Latest Latest Go to latest Published: Jul 2, 2021 License: MIT Imports: 12 Imported by: 0

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/project-vrcat/vrchat-go

Links

Open Source Insights

README ¶

vrchat-go

An unofficial Go module for VRChat API. (WIP)

Documentation ¶

Index ¶

Variables
type Map
type Options
type User
type VRCGO
- func NewClient() *VRCGO
- func NewClientWithOptions(opt Options) *VRCGO

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Err2FAFailed         = errors.New("2FA verification failed")
	ErrAuthTokenNotFound = errors.New("AuthToken not found")
)

Functions ¶

This section is empty.

Types ¶

type Map ¶

type Map map[string]interface{}

type Options ¶

type Options struct {
	ClientUserAgent string
	Timeout         time.Duration
	RetryCount      int
	ProxyURL        string
}

type User ¶

type User struct {
	// contains filtered or unexported fields
}

func (*User) CurrentUser ¶

func (v *User) CurrentUser() (user objects.CurrentUser, err error)

func (*User) FriendStatus ¶

func (v *User) FriendStatus(uid string) (isFriend, outgoingRequest, incomingRequest bool, err error)

func (*User) Friends ¶

func (v *User) Friends(offline bool) (list []objects.LimitedUser, err error)

type VRCGO ¶

type VRCGO struct {
	sync.Mutex

	User     User
	Pipeline *websocket.Pipeline
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient() *VRCGO

func NewClientWithOptions ¶

func NewClientWithOptions(opt Options) *VRCGO

func (*VRCGO) AuthToken ¶

func (v *VRCGO) AuthToken() (token string, err error)

func (*VRCGO) CallEvent ¶

func (v *VRCGO) CallEvent(name string, param interface{})

func (*VRCGO) Cookies ¶

func (v *VRCGO) Cookies() ([]*http.Cookie, error)

func (*VRCGO) Health ¶

func (v *VRCGO) Health() (bool, error)

func (v *VRCGO) Login(username, password string) (user objects.CurrentUser, err error)

func (*VRCGO) LoginWithSteam ¶

func (v *VRCGO) LoginWithSteam(steamTicket string) (user objects.CurrentUser, err error)

func (*VRCGO) Logout ¶

func (v *VRCGO) Logout() error

func (*VRCGO) RegisterEvent ¶

func (v *VRCGO) RegisterEvent(name string, callback func(interface{}))

func (*VRCGO) RemoteConfig ¶

func (v *VRCGO) RemoteConfig() (config objects.RemoteConfig, err error)

func (*VRCGO) SystemTime ¶

func (v *VRCGO) SystemTime() (t time.Time, err error)

func (*VRCGO) VerifyAuthToken ¶

func (v *VRCGO) VerifyAuthToken() (token string, err error)

func (*VRCGO) VerifyOTP ¶

func (v *VRCGO) VerifyOTP(code string) error

func (*VRCGO) VerifyTOTP ¶

func (v *VRCGO) VerifyTOTP(code string) error

func (*VRCGO) Visits ¶

func (v *VRCGO) Visits() (int, error)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
events
objects
pkg
websocket
websocket

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