Kullanıcı notları¶
Not, çağıranın başka bir hesap hakkında sakladığı kısa, özel bir metindir.
Bu sayfadaki tüm yollar yalnızca kullanıcıya yöneliktir. Kullanıcı oturumu token'ı (Authorization: Bearer <token>) gerektirirler. Geçerli bir Bot <token> kimlik bilgisi 403 ACCESS_DENIED ile, geçersiz olanı ise 401 UNAUTHORIZED ile reddedilir.
Not yalnızca yazarına özeldir
Hedef hesap notu hiçbir zaman bir HTTP yanıtında veya Gateway gönderiminde almaz. Notun ilişki gereksinimi yoktur; bu yüzden çağıran ne arkadaşı ne de engellediği bir hesap için de not tutabilir.
Kullanıcı notu nesnesi¶
Çağıranın tek bir hedef hesap için tuttuğu not.
Yapı¶
| Alan | Tür | Açıklama |
|---|---|---|
| note | string | Çağıranın hedef hesap için sakladığı not metni; not yoksa boş dize |
Saklanan bir not hiçbir zaman boş değildir: boş veya yalnızca boşluktan oluşan bir not yazmak onu siler.
Kullanıcı notları kaydı¶
Çağıranın sakladığı tüm notlar; hedef hesap kimliğinden not metnine bir eşleme olarak.
Yapı¶
| Alan | Tür | Açıklama |
|---|---|---|
| notes | map[snowflake, string] | Her özellik adı bir hedef hesabın snowflake değeridir ve değeri o hesabın not metnidir |
Notu olmayan bir hedefin özelliği yoktur; bu yüzden hiç notu olmayan bir hesap {"notes": {}} alır.
Gateway aynı eşlemeyi (notes sarmalayıcısı olmadan) Ready yükünün notes alanı olarak iletir; bu yüzden bağlı bir istemci Kullanıcı notlarını listele çağrısını yapmadan önce buna zaten sahiptir.
Örnek¶
{
"notes": {
"1501314428688998182": "met at the Berlin meetup",
"1501314428688998183": "always posts the good links"
}
}
Kullanıcı notlarını listele¶
GET /users/@me/notes
Çağıranın eksiksiz kullanıcı notları kaydını döndürür. İşlem sayfalanmaz; bu yüzden saklanan her not tek bir yanıtta gelir.
Notun oluşturulma veya değiştirilme zaman damgası yoktur.
Yanıt¶
| Durum | Gövde | Koşul |
|---|---|---|
| 200 | kullanıcı notları kaydı | Notlar döndürüldü; eşleme boş olabilir |
Hız sınırı¶
user:notes:read kovasında, kimliği doğrulanmış her kullanıcı için 10 saniyede 60 istek; Kullanıcı notunu getir ile paylaşılır.
Kullanıcı notunu getir¶
GET /users/@me/notes/{target_id}
Çağıranın tek bir hedef hesap için tuttuğu kullanıcı notu nesnesini döndürür.
Saklanmış notu olmayan bir hedef hata değil, boş bir note ile 200 döndürür. TEBHOS hedef hesabın var olduğunu denetlemez; bu yüzden bilinmeyen bir kimlik de aynı şekilde davranır.
Yol parametreleri¶
| Alan | Tür | Açıklama |
|---|---|---|
| target_id | snowflake | Notun tanımladığı hesabın kimliği |
Yanıt¶
| Durum | Gövde | Koşul |
|---|---|---|
| 200 | kullanıcı notu nesnesi | Not veya boş bir dize döndürüldü |
| 400 | hata yanıtı | target_id bir tamsayı değil ve istek BAD_REQUEST döndürüyor |
Örnek¶
Hız sınırı¶
user:notes:read kovasında, kimliği doğrulanmış her kullanıcı için 10 saniyede 60 istek; Kullanıcı notlarını listele ile paylaşılır.
Kullanıcı notunu ayarla¶
PUT /users/@me/notes/{target_id}
Çağıranın tek bir hedef hesap için notunu oluşturur, değiştirir veya siler. Gönderilen notu döndürür. Bir User Note Update Gateway olayı yayınlar.
Verilen metin, saklanan notun tamamı olur. Başındaki ve sonundaki boşluklar saklanmadan önce kaldırılır. Çağıran, bir bot hesabı ve kendi hesabı dahil herhangi bir kimlik için not saklayabilir; TEBHOS hedefin var olduğunu denetlemez.
Gönderilmeyen, null veya boş not onu siler
{}, {"note": null}, {"note": ""} ve yalnızca boşluktan oluşan bir not, saklanan notu siler. Ayrı bir silme yolu yoktur. İstek gövdesinin kendisi bir JSON nesnesi olmalıdır; boş bir istek gövdesi 400 ile reddedilir.
Yol parametreleri¶
| Alan | Tür | Açıklama |
|---|---|---|
| target_id | snowflake | Notun tanımladığı hesabın kimliği |
JSON gövdesi¶
| Alan | Tür | Açıklama |
|---|---|---|
| note? | ?string | Yeni ve eksiksiz not metni (en fazla 256 karakter); saklanan notu silmek için null |
256 karakterlik sınır, boşluklar kırpılmadan önce, gönderildiği hâliyle değer üzerinde Unicode karakter olarak sayılır.
Yanıt¶
| Durum | Gövde | Koşul |
|---|---|---|
| 200 | kullanıcı notu nesnesi | Not ayarlandı veya silindi. note, gönderilen değeri gönderildiği gibi (kırpılmadan) yansıtır; silmeden sonra boş dizedir |
| 400 | hata yanıtı | target_id bir tamsayı değil (BAD_REQUEST) veya note 256 karakterden uzun (INVALID_FORM_BODY) |
Yan etkiler¶
Metin vermek notu oluşturur veya değiştirir; metin vermeyen bir istek onu siler. User Note Update, mevcut değeri gönderen ve olmayan bir notu silen istekler dahil kabul edilen her istek için çağıranın kendi oturumlarına ulaşır.
Gönderim yükünde şu üyeler bulunur:
| Alan | Tür | Açıklama |
|---|---|---|
| id | snowflake | Hedef hesap kimliği |
| target_user_id | snowflake | Aynı kimlik; eski istemciler için korunur |
| note | string | Gönderildiği hâliyle not metni; silmede boş dize |
Hız sınırı¶
user:notes:write kovasında, kimliği doğrulanmış her kullanıcı için 10 saniyede 40 istek.
Eski not yolu¶
POST /profile/{profile_id}/note
Önceki TEBHOS istemcileri için korunan eski bir yol. Aynı {"note": ...} gövdesini alır ve Kullanıcı notunu ayarla ile aynı depolamaya yazar; bu yüzden boş değerler notu siler ve metin saklanmadan önce kırpılır. {"message": ..., "note": ...} ile 200 döndürür.
Kullanıcı notunu ayarla yolunu tercih edin
Eski yolun yola özgü bir hız sınırı kovası yoktur, 256 karakter sınırı uygulamaz ve User Note Update yayınlamaz; bu yüzden çağıranın diğer oturumlarına değişiklik bildirilmez. Yeni entegrasyonlar Kullanıcı notunu ayarla yolunu kullanmalıdır.