Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
74 lines (64 sloc) 2.18 KB
/**
* Copyright 2019 The Nakama Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Collections.Generic;
namespace Nakama
{
/// <summary>
/// A session authenticated for a user with Nakama server.
/// </summary>
public interface ISession
{
/// <summary>
/// The authentication token used to construct this session.
/// </summary>
string AuthToken { get; }
/// <summary>
/// If the user account for this session was just created.
/// </summary>
bool Created { get; }
/// <summary>
/// The UNIX timestamp when this session was created.
/// </summary>
long CreateTime { get; }
/// <summary>
/// The UNIX timestamp when this session will expire.
/// </summary>
long ExpireTime { get; }
/// <summary>
/// If the session has expired.
/// </summary>
bool IsExpired { get; }
/// <summary>
/// Any custom properties associated with this session.
/// </summary>
IDictionary<string, string> Vars { get; }
/// <summary>
/// The username of the user who owns this session.
/// </summary>
string Username { get; }
/// <summary>
/// The ID of the user who owns this session.
/// </summary>
string UserId { get; }
/// <summary>
/// Check the session has expired against the offset time.
/// </summary>
/// <param name="offset">The datetime to compare against this session.</param>
/// <returns>If the session has expired.</returns>
bool HasExpired(DateTime offset);
}
}
You can’t perform that action at this time.