Type Alias: Session ​
Session =
object
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2706
Session
Properties ​
$createdAt ​
$createdAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2714
Session creation date in ISO 8601 format.
$id ​
$id:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2710
Session ID.
$updatedAt ​
$updatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2718
Session update date in ISO 8601 format.
clientCode ​
clientCode:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2770
Client code name. View list of available options.
clientEngine ​
clientEngine:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2782
Client engine name.
clientEngineVersion ​
clientEngineVersion:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2786
Client engine name.
clientName ​
clientName:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2774
Client name.
clientType ​
clientType:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2766
Client type.
clientVersion ​
clientVersion:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2778
Client version.
countryCode ​
countryCode:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2802
Country two-character ISO 3166-1 alpha code.
countryName ​
countryName:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2806
Country name.
current ​
current:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2810
Returns true if this the current user session.
deviceBrand ​
deviceBrand:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2794
Device brand name.
deviceModel ​
deviceModel:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2798
Device model name.
deviceName ​
deviceName:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2790
Device name.
expire ​
expire:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2726
Session expiration date in ISO 8601 format.
factors ​
factors:
string[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2814
Returns a list of active session factors.
ip ​
ip:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2750
IP in use when the session was created.
mfaUpdatedAt ​
mfaUpdatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2822
Most recent date in ISO 8601 format when the session successfully passed MFA challenge.
osCode ​
osCode:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2754
Operating system code name. View list of available options.
osName ​
osName:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2758
Operating system name.
osVersion ​
osVersion:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2762
Operating system version.
provider ​
provider:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2730
Session Provider.
providerAccessToken ​
providerAccessToken:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2738
Session Provider Access Token.
providerAccessTokenExpiry ​
providerAccessTokenExpiry:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2742
The date of when the access token expires in ISO 8601 format.
providerRefreshToken ​
providerRefreshToken:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2746
Session Provider Refresh Token.
providerUid ​
providerUid:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2734
Session Provider User ID.
secret ​
secret:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2818
Secret used to authenticate the user. Only included if the request was made with an API key
userId ​
userId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:2722
User ID.