REST Resource: customEmojis

المرجع: CustomEmoji

يمثّل رمز إيموجي مخصّصًا.

تمثيل JSON 
{
  "name": string,
  "uid": string,
  "emojiName": string,
  "temporaryImageUri": string,
  "payload": {
    object (CustomEmojiPayload)
  }
}
الحقول
name

string

المعرّف اسم المورد الخاص برمز الإيموجي المخصّص الذي حدّده الخادم

التنسيق: customEmojis/{customEmoji}
uid

string

النتائج فقط. مفتاح فريد لمورد الرموز التعبيرية المخصّصة
emojiName

string

اختياريّ. غير قابل للتغيير الاسم الذي يوفّره المستخدم للرمز التعبيري المخصّص، والذي يكون فريدًا في المؤسسة

مطلوب عند إنشاء الرمز التعبيري المخصّص، وإخراجه فقط في الحالات الأخرى.

يجب أن تبدأ أسماء الرموز التعبيرية وتنتهي بنقطتَين، ويجب أن تكون بأحرف صغيرة ويمكن أن تحتوي فقط على أحرف أبجدية رقمية وواصلات وشرطات سفلية. يجب استخدام الواصلات والشرطات السفلية لفصل الكلمات ولا يمكن استخدامها بشكل متتابع.

مثلاً: :valid-emoji-name:
temporaryImageUri

string

النتائج فقط. عنوان URL مؤقت للصورة المخصّصة للرمز التعبيري، صالح لمدة 10 دقائق على الأقل يُرجى العِلم أنّه لا يتمّ تعبئة هذا الحقل في الردّ عند إنشاء الرمز التعبيري المخصّص.
payload

object (CustomEmojiPayload)

اختياريّ. الإدخال فقط بيانات الحمولة مطلوب عند إنشاء الرمز التعبيري المخصّص.

CustomEmojiPayload

بيانات الحمولة لرمز الإيموجي المخصّص

تمثيل JSON 
{
  "fileContent": string,
  "filename": string
}
الحقول
fileContent

string (bytes format)

مطلوب. الإدخال فقط الصورة المستخدَمة لرمز الإيموجي المخصّص

يجب أن تكون الحمولة أقل من 256 كيلوبايت وأن تكون أبعاد الصورة مربّعة وتتراوح بين 64 و500 بكسل. تخضع القيود للتغيير.
filename

string

مطلوب. الإدخال فقط اسم ملف الصورة.

امتدادات الملفات المتوافقة: .png و.jpg و.gif

الطُرق

create

 تنشئ رمزًا تعبيريًا مخصّصًا.

delete

 لحذف رمز تعبيري مخصّص

get

 لعرض تفاصيل عن رمز إيموجي مخصّص

list

 تعرض قائمة برموز الإيموجي المخصّصة التي تظهر للمستخدم الذي تم مصادقة هويته.