REST Resource: users.availability

संसाधन: उपलब्धता

यह कुकी, Google Chat में किसी व्यक्ति की उपलब्धता की मौजूदा जानकारी दिखाती है. इसमें उसकी स्थिति (जैसे, ऐक्टिव, अवे, 'परेशान न करें' मोड) और कोई भी कस्टम स्टेटस शामिल होता है.

JSON के काेड में दिखाना
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
फ़ील्ड
name

string

आइडेंटिफ़ायर. उपयोगकर्ता की उपलब्धता के संसाधन का नाम.

फ़ॉर्मैट: users/{user}/availability

{user}, People API या Admin SDK Directory API में मौजूद व्यक्ति का आईडी है. उदाहरण के लिए, users/123456789.

उपयोगकर्ता के ईमेल पते या me का इस्तेमाल, कॉल करने वाले व्यक्ति के लिए उपनाम के तौर पर भी किया जा सकता है. उदाहरण के लिए, users/user@example.com या users/me.

state

enum (State)

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता की उपलब्धता की मौजूदा स्थिति.

customStatus

object (CustomStatus)

ज़रूरी नहीं. उपयोगकर्ता की पसंद के मुताबिक स्थिति.

उपयोगकर्ता की उपलब्धता की स्थिति से जुड़ा अतिरिक्त मेटाडेटा. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

सिर्फ़ आउटपुट के लिए. अगर उपयोगकर्ता की स्थिति DO_NOT_DISTURB पर सेट है, तो मेटाडेटा.

एक-दूसरे से अलग फ़ील्ड के आखिर में.

राज्य

यह कुकी, उपयोगकर्ता की उपलब्धता की मौजूदा स्थिति के बारे में बताती है.

Enums
STATE_UNSPECIFIED डिफ़ॉल्ट मान. राज्य की जानकारी नहीं दी गई है.
ACTIVE हाल की गतिविधि के आधार पर, उपयोगकर्ता फ़िलहाल सक्रिय है.
IDLE फ़िलहाल, उपयोगकर्ता कुछ नहीं कर रहा है. इस स्थिति से पता चलता है कि उपयोगकर्ता ने कुछ समय पहले तक डिवाइस का इस्तेमाल किया था. इसके बाद, वह 'उपलब्ध नहीं है' स्थिति पर स्विच हो सकता है.
AWAY फ़िलहाल, उपयोगकर्ता उपलब्ध नहीं है. यह सेटिंग, ACTIVE या IDLE मोड में कुछ समय तक कोई गतिविधि न होने पर अपने-आप सेट हो सकती है. इसके अलावा, उपयोगकर्ता इसे मैन्युअल तरीके से भी सेट कर सकता है. availability.markAsAway के ज़रिए मैन्युअल तरीके से सेट करने पर, यह स्थिति उपयोगकर्ता गतिविधि के बावजूद बनी रहती है.
DO_NOT_DISTURB उपयोगकर्ता ने 'परेशान न करें' मोड चालू किया है.

DoNotDisturbMetadata

DO_NOT_DISTURB उपलब्धता की स्थिति से जुड़ा मेटाडेटा. इससे पता चलता है कि स्थिति कब खत्म होगी.

JSON के काेड में दिखाना
{
  "expirationTime": string
}
फ़ील्ड
expirationTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब तक उपयोगकर्ता को DO_NOT_DISTURB के तौर पर मार्क किया जाना चाहिए. यह तारीख, आने वाले समय में एक साल तक की कोई भी तारीख हो सकती है.

CustomStatus

यह कुकी, Google Chat में उपयोगकर्ता के कस्टम स्टेटस को दिखाती है. इसमें एक छोटा टेक्स्ट मैसेज शामिल होता है. इसमें एक इमोजी भी शामिल किया जा सकता है. उपयोगकर्ता इस इमोजी को अपनी उपलब्धता के बारे में ज़्यादा जानकारी देने के लिए सेट करता है.

JSON के काेड में दिखाना
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
फ़ील्ड
text

string

ज़रूरी है. कस्टम स्टेटस का टेक्स्ट. यह ज़्यादा से ज़्यादा 64 वर्णों वाली स्ट्रिंग होगी.

emoji

object (Emoji)

ज़रूरी है. कस्टम स्टेटस का इमोजी. सिर्फ़ यूनिकोड इमोजी इस्तेमाल किए जा सकते हैं. कस्टम इमोजी इस्तेमाल नहीं किए जा सकते.

कस्टम स्टेटस के खत्म होने का समय. इसे ऐब्सलूट टाइमस्टैंप या टाइम-टू-लाइव की अवधि के तौर पर तय किया जा सकता है. यहां ऐसे फ़ील्ड की सूची दी गई है जिनमें से सिर्फ़ एक को चुना जा सकता है. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
expireTime

string (Timestamp format)

कस्टम स्टेटस के खत्म होने का टाइमस्टैंप.

ttl

string (Duration format)

सिर्फ़ इनपुट के लिए. कस्टम स्टेटस की वह अवधि जिसके बाद वह स्टेटस हट जाता है.

एक-दूसरे से अलग फ़ील्ड के आखिर में.

तरीके

get

Google Chat में किसी व्यक्ति की उपलब्धता की जानकारी दिखाता है.

markAsActive

इस कुकी से, उपयोगकर्ता को Google Chat में ACTIVE के तौर पर मार्क किया जाता है.

markAsAway

इस कुकी से, उपयोगकर्ता को Google Chat में AWAY के तौर पर मार्क किया जाता है.

markAsDoNotDisturb

इस कुकी से, उपयोगकर्ता को Google Chat में DO_NOT_DISTURB के तौर पर मार्क किया जाता है.

patch

यह कुकी, किसी व्यक्ति के लिए उपलब्धता की जानकारी अपडेट करती है.