MenuHost extensions

Query · GET

fyi.opensocial.getJoinRequest

The caller's own pending join request, if any.

The caller's own pending request to join, if they have one. Requires no action: listJoinRequests is the moderator's queue and needs `admit`, which leaves a requester unable to see the request they themselves made. Returns nothing once a request has been decided, so a denial is not disclosed.

Requires
no role

Parameters

groupstring · didrequired

The group DID. Every method is served by the group's host and authorized against that group's roles.

Output

requestfyi.opensocial.defs#joinRequestView

Schema

Lexicon JSON
{
  "lexicon": 1,
  "id": "fyi.opensocial.getJoinRequest",
  "defs": {
    "main": {
      "type": "query",
      "description": "The caller's own pending request to join, if they have one. Requires no action: listJoinRequests is the moderator's queue and needs `admit`, which leaves a requester unable to see the request they themselves made. Returns nothing once a request has been decided, so a denial is not disclosed.",
      "parameters": {
        "type": "params",
        "required": [
          "group"
        ],
        "properties": {
          "group": {
            "type": "string",
            "format": "did",
            "description": "The group DID. Every method is served by the group's host and authorized against that group's roles."
          }
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": [],
          "properties": {
            "request": {
              "type": "ref",
              "ref": "fyi.opensocial.defs#joinRequestView"
            }
          }
        }
      }
    }
  }
}

← All host extensions