משאב: תווית
תוויות משמשות לסיווג הודעות ושרשורים בתיבת הדואר של המשתמש. מספר התוויות המקסימלי הנתמך בתיבת הדואר של המשתמש הוא 10,000.
ייצוג JSON |
---|
{ "id": string, "name": string, "messageListVisibility": enum ( |
שדות | |
---|---|
id |
המזהה שלא ניתן לשינוי של התווית. |
name |
השם המוצג של התווית. |
messageListVisibility |
החשיפה של הודעות עם התווית הזו ברשימת ההודעות בממשק האינטרנט של Gmail. |
labelListVisibility |
החשיפה של התווית ברשימת התוויות בממשק האינטרנט של Gmail. |
type |
סוג הבעלים של התווית. תוויות משתמש נוצרות על ידי המשתמש, והמשתמשים יכולים לשנות ולמחוק אותן ואפשר להחיל אותן על כל הודעה או שרשור. תוויות מערכת נוצרות באופן פנימי ולא ניתן להוסיף, לשנות או למחוק אותן. בנסיבות מסוימות, ייתכן שניתן יהיה להחיל תוויות מערכת על הודעות ושרשורים או להסיר אותן, אבל לא מובטח שזה המצב. לדוגמה, משתמשים יכולים להחיל ולהסיר את התוויות |
messagesTotal |
המספר הכולל של ההודעות עם התווית. |
messagesUnread |
מספר ההודעות שלא נקראו עם התווית. |
threadsTotal |
המספר הכולל של השרשורים עם התווית. |
threadsUnread |
מספר השרשורים עם התווית שלא נקראו. |
color |
הצבע שיש להקצות לתווית. הצבע זמין רק לתוויות שבהן |
MessageListVisibility
טיפוסים בני מנייה (enums) | |
---|---|
show |
הצגת התווית ברשימת ההודעות. |
hide |
אל תציג את התווית ברשימת ההודעות. |
LabelListVisibility
טיפוסים בני מנייה (enums) | |
---|---|
labelShow |
הצגת התווית ברשימת התוויות. |
labelShowIfUnread |
הצג את התווית אם יש הודעות שלא נקראו עם התווית הזו. |
labelHide |
לא להציג את התווית ברשימת התוויות. |
תיאור
טיפוסים בני מנייה (enums) | |
---|---|
system |
התוויות שנוצרו על ידי Gmail. |
user |
תוויות מותאמות אישית שנוצרו על ידי המשתמש או האפליקציה. |
צבע
ייצוג JSON |
---|
{ "textColor": string, "backgroundColor": string } |
שדות | |
---|---|
textColor |
צבע הטקסט של התווית, מיוצג כמחרוזת הקסדצימלית. חובה למלא את השדה הזה כדי להגדיר צבע של תווית. #4360,4375,7458787, שונים |
backgroundColor |
צבע הרקע מיוצג כמחרוזת הקסדצימלית #RRGGBB (לדוגמה #000000). חובה למלא את השדה הזה כדי להגדיר צבע של תווית. #4360,4375,7458787, שונים |
שיטות |
|
---|---|
|
יצירת תווית חדשה. |
|
מוחקת באופן מיידי ולצמיתות את התווית שצוינה ומסירה אותה מכל ההודעות והשרשורים שעליהם היא חלה. |
|
הפונקציה מקבלת את התווית שצוינה. |
|
בתיבת הדואר של המשתמש מופיעה רשימה של כל התוויות. |
|
תיקון התווית שצוינה. |
|
עדכון התווית שצוינה. |