Lewati ke konten utama

updateUser

Memperbarui objek pengguna tunggal. πŸ” Metode ini memerlukan otorisasi.

Deskripsi​

Metode ini memperbarui data pengguna yang terotorisasi. Ini mengembalikan Promise yang menyelesaikan ke boolean (true jika berhasil).

Pengguna.updateUser(

body*, langCode

);

Skema parameter​

Skema

body(diperlukan): IUserBody
Badan permintaan
contoh:

{
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "email_reg",
      "value": "your-email@oneentery.cloud"
    },
    {
      "marker": "password_reg",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Username"
    }
  ],
  "notificationData": {
    "email": "example@oneentry.cloud",
    "phonePush": [
      "+99999999999"
    ],
    "phoneSMS": "+99999999999"
  },
  "state": {}
}

body.formIdentifier(diperlukan): string
Identifikasi teks dari formulir.
contoh: "form_12345"

body.langCode: string
Kode bahasa untuk lokalisasi. Default: "en_US".

body.authData: IAuthData[]
Array objek data otentikasi dengan penanda dan nilai.
contoh:

[
  {
    "marker": "password",
    "value": "12345"
  }
]

authData.marker(diperlukan): string
Penanda yang mengidentifikasi bidang otentikasi.
contoh: "login"

authData.value(diperlukan): string
Nilai dari bidang otentikasi.
contoh: .com"

body.formData: IAuthFormData | IAuthFormData[]
Objek data formulir atau array objek data formulir.
contoh:

[
  {
    "marker": "first_name",
    "type": "string",
    "value": "John"
  },
  {
    "marker": "last_name",
    "type": "string",
    "value": "Doe"
  }
]

formData.marker(diperlukan): string
Identifikasi unik untuk bidang formulir.
contoh: "email"

formData.type(diperlukan): string
Jenis bidang formulir, seperti 'string', 'email', dll.
contoh: "string"

formData.value(diperlukan): string
Nilai yang dimasukkan di bidang formulir.
contoh: "example@oneentry.cloud"

body.notificationData: object
Objek yang berisi data notifikasi, termasuk informasi email dan telepon.
contoh:

{
  "email": "example@oneentry.cloud",
  "phonePush": [
    "+99999999999"
  ],
  "phoneSMS": "+99999999999"
}

body.state: object
Objek yang berisi informasi status tambahan.
contoh:

{
  "key": "value"
}

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

Contoh​

Contoh minimal​


await AuthProvider.auth(
  "email",
  {
    "authData": [
      {
        "marker": "email_reg",
        "value": "your@email.com",
      },
      {
        "marker": "password_reg",
        "value": "yourPassword"
      }
    ]
  }
);

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "password",
      "value": "yourPassword"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Username"
    }
  ],
  "notificationData": {
    "email": "example@oneentry.cloud",
    "phonePush": ["+99999999999"],
    "phoneSMS": "+99999999999"
  },
  "state": {}
};

const response = await Users.updateUser(body);

Contoh untuk parameter body dengan berbagai jenis data​

Contoh dengan atribut tipe sederhana "string", "integer", "float"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "last_name",
      "type": "string",
      "value": "Π€Π΅Π΄ΠΎΡ€ Иванов"
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  },
  "state": {}
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "date", "dateTime", "time"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "birthday",
      "type": "date",
      "value": {
        "fullDate": "2024-05-07T21:02:00.000Z",
        "formattedValue": "08-05-2024 00:02",
        "formatString": "DD-MM-YYYY HH:mm"
      }
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "text"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "text",
      "value": {
        "htmlValue": "<p>Π­Ρ‚ΠΎ я</p>",
        "plainValue": "Π­Ρ‚ΠΎ я",
        "mdValue": "*Π­Ρ‚ΠΎ я*",
        "params": {
          "isImageCompressed": true,
          "editorMode": "html"
        }
      }
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "textWithHeader"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "about",
      "type": "textWithHeader",
      "value": {
        "header": "Π—Π°Π³ΠΎΠ»ΠΎΠ²ΠΎΠΊ",
        "htmlValue": "<p>Π­Ρ‚ΠΎ я</p>",
        "plainValue": "Π­Ρ‚ΠΎ я",
        "mdValue": "*Π­Ρ‚ΠΎ я*",
        "params": {
          "isImageCompressed": true,
          "editorMode": "html"
        }
      }
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "image" dan "groupOfImages"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "avatar",
      "type": "image",
      "value": [
        {
          "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "size": 392585,
          "previewLink": "",
          "params": {
            "isImageCompressed": true
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "file"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "picture",
      "type": "file",
      "value": [
        {
          "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
          "size": 392585
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "radioButton"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "radioButton",
      "value": {
        "title": "red",
        "value": "1",
        "extended": {
          "value": "красный",
          "type": "string"
        }
      }
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "list"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "selector",
      "type": "list",
      "value": [
        {
          "title": "red",
          "value": "1",
          "extended": {
            "value": "красный",
            "type": "string"
          }
        }
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "entity" (daftar bersarang)​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "entity-selector",
      "type": "entity",
      "value": [
        1,
        2
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh dengan atribut tipe "timeInterval"​

const body = {
  "formIdentifier": "reg",
  "authData": [
    {
      "marker": "login",
      "value": "test"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ],
  "formData": [
    {
      "marker": "interval",
      "type": "timeInterval",
      "value": [
        [
          "2025-02-11T16:00:00.000Z",
          "2025-02-13T16:00:00.000Z"
        ]
      ]
    }
  ],
  "notificationData": {
    "email": "test@test.ru",
    "phonePush": [],
    "phoneSMS": "+79991234567"
  }
};

const response = await Users.updateUser(body);

Contoh pengembalian​

true

Contoh penggunaan​

Panduan langkah demi langkah dalam dokumentasi:

  • Perbarui pengguna β€” ubah atribut pengguna seperti nomor telepon pada akun yang terautentikasi.

Coba secara langsung​

Jalankan metode ini secara interaktif di JS SDK sandbox β€” sambungkan URL Proyek dan Token Aplikasi Anda pada kunjungan pertama, lalu buka:

  • Perbarui pengguna β€” ubah atribut pengguna seperti nomor telepon pada akun yang terautentikasi.