Class: Appwrite::Models::User

Inherits:
Object
  • Object
show all
Defined in:
lib/appwrite/models/user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(id:, created_at:, updated_at:, name:, password:, hash:, hash_options:, registration:, status:, labels:, password_update:, email:, phone:, email_verification:, email_canonical:, email_is_free:, email_is_disposable:, email_is_corporate:, email_is_canonical:, phone_verification:, mfa:, prefs:, targets:, accessed_at:, impersonator:, impersonator_user_id:) ⇒ User

Returns a new instance of User.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/appwrite/models/user.rb', line 33

def initialize(
    id:,
    created_at:,
    updated_at:,
    name:,
    password: ,
    hash: ,
    hash_options: ,
    registration:,
    status:,
    labels:,
    password_update:,
    email:,
    phone:,
    email_verification:,
    email_canonical: ,
    email_is_free: ,
    email_is_disposable: ,
    email_is_corporate: ,
    email_is_canonical: ,
    phone_verification:,
    mfa:,
    prefs:,
    targets:,
    accessed_at:,
    impersonator: ,
    impersonator_user_id: 
)
    @id = id
    @created_at = created_at
    @updated_at = updated_at
    @name = name
    @password = password
    @hash = hash
    @hash_options = hash_options
    @registration = registration
    @status = status
    @labels = labels
    @password_update = password_update
    @email = email
    @phone = phone
    @email_verification = email_verification
    @email_canonical = email_canonical
    @email_is_free = email_is_free
    @email_is_disposable = email_is_disposable
    @email_is_corporate = email_is_corporate
    @email_is_canonical = email_is_canonical
    @phone_verification = phone_verification
    @mfa = mfa
    @prefs = prefs
    @targets = targets
    @accessed_at = accessed_at
    @impersonator = impersonator
    @impersonator_user_id = impersonator_user_id
end

Instance Attribute Details

#accessed_at ⇒ Object (readonly)

Returns the value of attribute accessed_at.



29
30
31
 
# File 'lib/appwrite/models/user.rb', line 29

def accessed_at
  @accessed_at
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



7
8
9
 
# File 'lib/appwrite/models/user.rb', line 7

def created_at
  @created_at
end

#email ⇒ Object (readonly)

Returns the value of attribute email.



17
18
19
 
# File 'lib/appwrite/models/user.rb', line 17

def email
  @email
end

#email_canonical ⇒ Object (readonly)

Returns the value of attribute email_canonical.



20
21
22
 
# File 'lib/appwrite/models/user.rb', line 20

def email_canonical
  @email_canonical
end

#email_is_canonical ⇒ Object (readonly)

Returns the value of attribute email_is_canonical.



24
25
26
 
# File 'lib/appwrite/models/user.rb', line 24

def email_is_canonical
  @email_is_canonical
end

#email_is_corporate ⇒ Object (readonly)

Returns the value of attribute email_is_corporate.



23
24
25
 
# File 'lib/appwrite/models/user.rb', line 23

def email_is_corporate
  @email_is_corporate
end

#email_is_disposable ⇒ Object (readonly)

Returns the value of attribute email_is_disposable.



22
23
24
 
# File 'lib/appwrite/models/user.rb', line 22

def email_is_disposable
  @email_is_disposable
end

#email_is_free ⇒ Object (readonly)

Returns the value of attribute email_is_free.



21
22
23
 
# File 'lib/appwrite/models/user.rb', line 21

def email_is_free
  @email_is_free
end

#email_verification ⇒ Object (readonly)

Returns the value of attribute email_verification.



19
20
21
 
# File 'lib/appwrite/models/user.rb', line 19

def email_verification
  @email_verification
end

#hash ⇒ Object (readonly)

Returns the value of attribute hash.



11
12
13
 
# File 'lib/appwrite/models/user.rb', line 11

def hash
  @hash
end

#hash_options ⇒ Object (readonly)

Returns the value of attribute hash_options.



12
13
14
 
# File 'lib/appwrite/models/user.rb', line 12

def hash_options
  @hash_options
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



6
7
8
 
# File 'lib/appwrite/models/user.rb', line 6

def id
  @id
end

#impersonator ⇒ Object (readonly)

Returns the value of attribute impersonator.



30
31
32
 
# File 'lib/appwrite/models/user.rb', line 30

def impersonator
  @impersonator
end

#impersonator_user_id ⇒ Object (readonly)

Returns the value of attribute impersonator_user_id.



31
32
33
 
# File 'lib/appwrite/models/user.rb', line 31

def impersonator_user_id
  @impersonator_user_id
end

#labels ⇒ Object (readonly)

Returns the value of attribute labels.



15
16
17
 
# File 'lib/appwrite/models/user.rb', line 15

def labels
  @labels
end

#mfa ⇒ Object (readonly)

Returns the value of attribute mfa.



26
27
28
 
# File 'lib/appwrite/models/user.rb', line 26

def mfa
  @mfa
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



9
10
11
 
# File 'lib/appwrite/models/user.rb', line 9

def name
  @name
end

#password ⇒ Object (readonly)

Returns the value of attribute password.



10
11
12
 
# File 'lib/appwrite/models/user.rb', line 10

def password
  @password
end

#password_update ⇒ Object (readonly)

Returns the value of attribute password_update.



16
17
18
 
# File 'lib/appwrite/models/user.rb', line 16

def password_update
  @password_update
end

#phone ⇒ Object (readonly)

Returns the value of attribute phone.



18
19
20
 
# File 'lib/appwrite/models/user.rb', line 18

def phone
  @phone
end

#phone_verification ⇒ Object (readonly)

Returns the value of attribute phone_verification.



25
26
27
 
# File 'lib/appwrite/models/user.rb', line 25

def phone_verification
  @phone_verification
end

#prefs ⇒ Object (readonly)

Returns the value of attribute prefs.



27
28
29
 
# File 'lib/appwrite/models/user.rb', line 27

def prefs
  @prefs
end

#registration ⇒ Object (readonly)

Returns the value of attribute registration.



13
14
15
 
# File 'lib/appwrite/models/user.rb', line 13

def registration
  @registration
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



14
15
16
 
# File 'lib/appwrite/models/user.rb', line 14

def status
  @status
end

#targets ⇒ Object (readonly)

Returns the value of attribute targets.



28
29
30
 
# File 'lib/appwrite/models/user.rb', line 28

def targets
  @targets
end

#updated_at ⇒ Object (readonly)

Returns the value of attribute updated_at.



8
9
10
 
# File 'lib/appwrite/models/user.rb', line 8

def updated_at
  @updated_at
end

Class Method Details

.from(map:) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/appwrite/models/user.rb', line 89

def self.from(map:)
    User.new(
        id: map["$id"],
        created_at: map["$createdAt"],
        updated_at: map["$updatedAt"],
        name: map["name"],
        password: map["password"],
        hash: map["hash"],
        hash_options: map["hashOptions"],
        registration: map["registration"],
        status: map["status"],
        labels: map["labels"],
        password_update: map["passwordUpdate"],
        email: map["email"],
        phone: map["phone"],
        email_verification: map["emailVerification"],
        email_canonical: map["emailCanonical"],
        email_is_free: map["emailIsFree"],
        email_is_disposable: map["emailIsDisposable"],
        email_is_corporate: map["emailIsCorporate"],
        email_is_canonical: map["emailIsCanonical"],
        phone_verification: map["phoneVerification"],
        mfa: map["mfa"],
        prefs: Preferences.from(map: map["prefs"]),
        targets: map["targets"].map { |it| Target.from(map: it) },
        accessed_at: map["accessedAt"],
        impersonator: map["impersonator"],
        impersonator_user_id: map["impersonatorUserId"]
    )
end

Instance Method Details

#to_map ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/appwrite/models/user.rb', line 120

def to_map
    {
        "$id": @id,
        "$createdAt": @created_at,
        "$updatedAt": @updated_at,
        "name": @name,
        "password": @password,
        "hash": @hash,
        "hashOptions": @hash_options,
        "registration": @registration,
        "status": @status,
        "labels": @labels,
        "passwordUpdate": @password_update,
        "email": @email,
        "phone": @phone,
        "emailVerification": @email_verification,
        "emailCanonical": @email_canonical,
        "emailIsFree": @email_is_free,
        "emailIsDisposable": @email_is_disposable,
        "emailIsCorporate": @email_is_corporate,
        "emailIsCanonical": @email_is_canonical,
        "phoneVerification": @phone_verification,
        "mfa": @mfa,
        "prefs": @prefs.to_map,
        "targets": @targets.map { |it| it.to_map },
        "accessedAt": @accessed_at,
        "impersonator": @impersonator,
        "impersonatorUserId": @impersonator_user_id
    }
end