Function: app.Login

Performs user login.

Deprecated; only available in AOP API versions older than wg 0.6.0.

Syntax

{
	"method": "app.Login",
	"params": {
		"user": "...",
		"password": "...",
		"forced": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Login( AdvString user, AdvString password, std::optional<bool> forced = std::nullopt );
public Task<bool> LoginAsync(string user, string password, bool? forced = null, CancellationToken ct = default);
login(user: string, password: string, forced?: boolean | undefined): Promise<boolean>;

Parameters

user : string

User login or code.

password : string

User password.

forced : bool optional

Login without queries, unsaved content may be lost.

Result : bool

Login request executed.

Remarks

This method requires API control access.