משאב: Matter
מייצג עניין.
כדי לעבוד עם משאבי Vault, לחשבון צריכות להיות ההרשאות הנדרשות ב-Vault וגישה לעניין. כדי לגשת לעניין, החשבון צריך ליצור את העניין, לשתף איתו את העניין או לקבל את ההרשאה הצגת כל העניינים.
ייצוג JSON |
---|
{ "matterId": string, "name": string, "description": string, "state": enum ( |
שדות | |
---|---|
matterId |
מזהה העניין, שנוצר על ידי השרת. יש להשאיר את השדה ריק כשיוצרים עניין. |
name |
שם העניין. |
description |
תיאור אופציונלי לעניין. |
state |
מצב העניין. |
matterPermissions[] |
בתיבת הדו-שיח הזו מפורטים המשתמשים וההרשאות שלהם בעניין. אין כרגע הגבלה המוגדרת על מתכנת על מספר ההרשאות שיכולות להיות בעניין. |
ארץ
המצב של עניין.
טיפוסים בני מנייה (enums) | |
---|---|
STATE_UNSPECIFIED |
לא צוין מצב בעניין. |
OPEN |
העניין פתוח. |
CLOSED |
העניין נסגר. |
DELETED |
העניין נמחק. |
MatterPermission
המשתמשים יכולים להיות הבעלים או שותפי העריכה של העניין. לכל עניין יש בעלים אחד בלבד. כל המשתמשים האחרים שיכולים לגשת לעניין הם שותפי עריכה. כשחשבון נמחק לצמיתות, המשאבים המתאימים ב- MatterPermission יפסיקו להיות קיימים.
ייצוג JSON |
---|
{
"role": enum ( |
שדות | |
---|---|
role |
תפקיד המשתמש בעניין. |
accountId |
מספר החשבון, כפי שסופק על ידי Admin SDK. |
AclRole
הרשאות המשתמש האפשריות עבור עניין, בסדר מוגדל של הרשאות.
טיפוסים בני מנייה (enums) | |
---|---|
ROLE_UNSPECIFIED |
לא הוקצה תפקיד. |
COLLABORATOR |
שותף עריכה בנושא. |
OWNER |
הבעלים של העניין. |
שיטות |
|
---|---|
|
הוספת חשבון כשותף עריכה של עניין. |
|
סוגר את העניין שצוין. |
|
סופרת את החשבונות שעובדו על ידי השאילתה שצוינה. |
|
יוצר עניין עם השם והתיאור הנתונים. |
|
מחיקת העניין שצוין. |
|
הפונקציה מקבלת את העניין שצוין. |
|
מוצגים כאן רשימה של עניינים שיש למגיש הבקשה גישה אליהם. |
|
מסיר חשבון כשותף עריכה של עניין. |
|
פתיחה מחדש של העניין שצוין. |
|
ביטול המחיקה של העניין שצוין. |
|
מעדכן את העניין שצוין. |