VRChatClientBuilder Class

Namespace: VRChat.API.Client
Inherited: System.Object

The core of VRChat.API.Client. The VRChatClientBuilder class provides a Fluent API for building IVRChat clients, and smoothly authentication against VRChat's API, with a rebuilding pipeline if ever needed.

Constructor

  1. VRChatClientBuilder()
  2. VRChatClientBuilder(VRChat.API.Client.Configuration incomingConfiguration)

Methods

  1. From(VRChat.API.Client.Configuration incomingConfiguration)
  2. WithCredentials(string username, string password, string auth, string apiKey)
  3. WithCredentials(string username, string password, string apiKey)
  4. WithCredentials(string username, string password)
  5. WithUsername(string username)
  6. WithPassword(string password)
  7. WithApiKey(string apiKey)
  8. WithAuthCookie(string auth)
  9. WithUserAgent(string userAgent)
  10. WithTimeout(System.TimeSpan timeout)
  11. WithProxy(System.Net.WebProxy proxy)
  12. WithProxy(string url, bool bypass)
  13. Build(bool useWithoutCredentials)

Constructors


public VRChatClientBuilder()

Initializes a blank VRChatClientBuilder

public VRChatClientBuilder(VRChat.API.Client.Configuration incomingConfiguration)

Parameters
Type Name Description
VRChat.API.Client.Configuration
 incomingConfiguration The Configuration to initialize with as a base
Initializes a VRChatClientBuilder from a Configuration (if any)
Note: This should not be used unless you know what you're doing

Methods


public From(VRChat.API.Client.Configuration incomingConfiguration)

Parameters
Type Name Description
VRChat.API.Client.Configuration
 incomingConfiguration The Configuration to initialize with as a base
Creates a VRChatClientBuilder from a Configuration
Note: This should not be used unless you know what you're doing

public WithCredentials(string username, string password, string auth, string apiKey)

Parameters
Type Name Description
string
 username
string
 password
string
 auth
string
 apiKey

public WithCredentials(string username, string password, string apiKey)

Parameters
Type Name Description
string
 username
string
 password
string
 apiKey

public WithCredentials(string username, string password)

Parameters
Type Name Description
string
 username
string
 password

public WithUsername(string username)

Parameters
Type Name Description
string
 username

public WithPassword(string password)

Parameters
Type Name Description
string
 password

public WithApiKey(string apiKey)

Parameters
Type Name Description
string
 apiKey

public WithAuthCookie(string auth)

Parameters
Type Name Description
string
 auth

public WithUserAgent(string userAgent)

Parameters
Type Name Description
string
 userAgent

public WithTimeout(System.TimeSpan timeout)

Parameters
Type Name Description
System.TimeSpan
 timeout

public WithProxy(System.Net.WebProxy proxy)

Parameters
Type Name Description
System.Net.WebProxy
 proxy

public WithProxy(string url, bool bypass)

Parameters
Type Name Description
string
 url
bool
 bypass

public Build(bool useWithoutCredentials)

Parameters
Type Name Description
bool
 useWithoutCredentials