IVRChatClientFactory Class

Namespace: VRChat.API.Extensions.Hosting
Inherited: System.Object

An interface used for implementing a factory to build IVRChat clients from DI.

Methods

  1. CreateClient()
  2. CreateClient(string name)
  3. LoginAllClientsAsync()
  4. LoginClientAsync(string name)

Methods


public CreateClient()

Return
Type Description
An instance of IVRChat from the default client provider.
Creates a client using the default client provider and configuration.

public CreateClient(string name)

Parameters
Type Name Description
string
name The name of the client to create
Return
Type Description
An instance of IVRChat from the named client provider.
Creates a named client from the client provider and named configuration.

public LoginAllClientsAsync()

Return
Type Description
A Task representing this asyncronous operation.
Calls TryLoginAsync on ALL of the registered clients, thus forcing them to have a populated authcookie.
This also ensures that all clients are logged in. This method does not throw an exception.

public LoginClientAsync(string name)

Parameters
Type Name Description
string
name The name of the client to login
Return
Type Description
A Task representing this asyncronous operation.
Calls TryLoginAsync on the named client, thus forcing the client to have a populated authcookie.
This also ensures that the specified client is logged in. This method does not throw an exception.