Click or drag to resize

LoginRequest Constructor (String, String, String, ISFSObject)

Creates a new LoginRequest instance.

Namespace:  Sfs2X.Requests
Assembly:  SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
Syntax
C#
public LoginRequest(
	string userName,
	string password,
	string zoneName,
	ISFSObject parameters
)

Parameters

userName
Type: SystemString
The name to be assigned to the user. If an empty string is passed and the Zone allows guest users, the name is generated automatically by the server.
password
Type: SystemString
The user password to access the system. SmartFoxServer doesn't offer a default authentication system, so the password must be validated implementing a custom login system in the Zone's server-side Extension.
zoneName
Type: SystemString
The name (case-sensitive) of the server Zone to login to; if a Zone name is not specified, the client will use the setting loaded via LoadConfig method.
parameters
Type: Sfs2X.Entities.DataISFSObject
An instance of SFSObject containing custom parameters to be passed to the Zone Extension (requires a custom login system to be in place). Default value is null.
Remarks
The instance must be passed to the SmartFox.Send method for the request to be performed.
See Also