Click or drag to resize

ContextFactoryCreateByLoginOrEmailAndPassword Method

Creates a new context of execution for the user with the specified login (or email) and password.

Namespace:  AskiaPortalCmn
Assembly:  AskiaPortalCmn (in AskiaPortalCmn.dll) Version: 1.7.0-build068
Syntax
Copy
public static IContext CreateByLoginOrEmailAndPassword(
	string loginOrEmail,
	string password,
	string apiKey = null
)

Parameters

loginOrEmail
Type: SystemString
Login or email of user.
password
Type: SystemString
Password of user.
apiKey (Optional)
Type: SystemString
Indicates the API key of the application that currently request a context. If null, we assume that the application in used is AskiaPortal.

Return Value

Type: IContext
Context of execution
Remarks

The context created will restrict the usage of API methods according to the role of the user.

If the user is not found it return an invalid context with no user
You may check the validity of the context using Validate

Examples

This example shows how to create a context to authenticate a user using his login and password.

Copy
using system;
using AskiaPortalCmn;

namespace MyApp 
{
    class Program
    {
         static void Main(string[] args)
         {
                var context = ContextFactory.CreateByLoginOrEmailAndPassword("my-login", "secret");       
                var validationResult = context.Validate();
                if (validationResult.Success)
                {
                    Console.WriteLine("Context successfully created for the user `{0} {1} ({2})`",
                                        context.User.FirstName, context.User.LastName, context.User.Login);
                }
                else
                {
                    Console.Error.WriteLine("Unable to create the context");
                    Console.Error.Write(validationResult.Exception.Message);
                }
         }
    }
}
See Also