/Xmpp/PresenceProbe
Gets the latest presence issued by a contact in your roster who has approved your presence subscription request.
Note: The result to the presence probe request will give you the latest Full JID published by the contact. This Full JID can be used to make directed information queries to the contact.
Security Note: You are only allowed to send a presence probe to contacts that have approved a presence subscription from you.
Note 2: If you request the presence of an entity to which you do not have a presence subscription, one will be sent automatically. If you want to send custom XML in the presence subscription request, you should call SendPresenceSubscription.md first.
JSON
- Request
{ "to":Required(Str(PTo)) }- Response (if successful)
{ "jid": Required(Str(PJid)), "type": Required(Str(PType)), "received": Required(DateTime(PReceived)), "Stanza": Required(PStanza) }
XML
- Request
<PresenceProbe xmlns="https://waher.se/Schema/BrokerAgent.xsd" to=(Required(Str(PTo))) />- Response (if successful)
<ProbeResult xmlns="https://waher.se/Schema/BrokerAgent.xsd" jid=(Required(Str(PJid))) type=(Required(Str(PType))) received=(Required(DateTime(PReceived)))> <Stanza><[Required(Xml(PStanza))]></Stanza> </ProbeResult>
Input Parameters
| Parameter | Description |
|---|---|
PTo |
Bare JID of contact to whom the presence probe is directed. |
Response Parameters
| Parameter | Description |
|---|---|
PJid |
JID of latest presence from contact. |
PType |
Type of presence sent. Can be the empty string (meaning available) or unavailable. |
PReceived |
When presence was received by the server of the contact. |
PStanza |
Actual presence stanza, containing information sent by the contact. Contents may vary depending on type of contact. |
Note Underlying communication protocol is XMPP, which encodes information using XML. When requesting information encoded as JSON, this XML is automatically transformed into JSON. When XML is transformed into JSON objects, the special names __name and __ns can be used to get information about what XML names and namespaces have been used. XML attributes are encoded as properties. Child elements are also encoded as properties (if only one child element occurs with the same name), or as vectors of objects (if more than one child element occurs with the same name).
Javascript Library
Use the following asynchronous method in the Javascript Library, to call this resource.
var Response = await AgentAPI.Xmpp.PresenceProbe(BareJid);