zulip/templates/zerver/api/arguments.json

{
    "private-message.md":[
        {
            "argument":"type",
            "description":"The type of message to be sent. `private` for a private message and `stream` for a [stream message](/api/stream-message).",
            "required":"Required",
            "example":"private"
        },
        {
            "argument":"to",
            "description":"A JSON-encoded list containing the usernames of the recipients.",
            "required":"Required",
            "example":"wdaher@example.com"
        },
        {
            "argument":"content",
            "description":"The content of the message. Maximum message size of 10000 bytes.",
            "required":"Required",
            "example":"Hello"
        }
    ],
    "stream-message.md":[
        {
            "argument":"type",
            "description":"The type of message to be sent. `stream` for a stream message and `private` for a [private message](/api/private-message).",
            "required":"Required",
            "example":"stream"
        },
        {
            "argument":"to",
            "description":"A string identifying the stream.",
            "required":"Required",
            "example":"Denmark"
        },
        {
            "argument":"subject",
            "description":"The topic of the message. Only required if `type` is `stream`. Defaults to `None`. Maximum length of 60 characters.",
            "required":"Optional",
            "example":"Castle"
        },
        {
            "argument":"content",
            "description":"The content of the message. Maximum message size of 10000 bytes.",
            "required":"Required",
            "example":"Hello"
        }
    ],
    "get-all-streams.md":[
        {
            "argument":"include_public",
            "description":"Include all public streams. Default is `True`.",
            "required":"Optional",
            "example":"`True` or `False`"
        },
        {
            "argument":"include_subscribed",
            "description":"Include all streams that the user is subscribed to. Default is `True`.",
            "required":"Optional",
            "example":"`True` or `False`"
        },
        {
            "argument":"include_all_active",
            "description":"Include all active streams. The user must have administrative privileges to use this parameter. Default is `False`.",
            "required":"Optional",
            "example":"`True` or `False`"
        },
        {
            "argument":"include_default",
            "description":"Include all default streams for the user's realm. Default is `False`.",
            "required":"Optional",
            "example":"`True` or `False`"
        }
    ],
    "get-stream-id.md":[
        {
            "argument":"stream",
            "description":"The name of the stream to retrieve the ID for.",
            "required":"Required",
            "example":"Denmark"
        }
    ],
    "render-message.md":[
        {
            "argument":"content",
            "description":"The content of the message.",
            "required":"Required",
            "example":"**foo**"
        }
    ],
    "get-all-users.md":[
        {
            "argument":"client_gravatar",
            "description":"The `client_gravatar` field is set to `True` if clients can compute their own gravatars. Default is `False`.",
            "required":"Optional",
            "example":"`True` or `False`"
        }
    ],
    "register-queue.md":[
        {
            "argument":"apply_markdown",
            "description":"Set to `True` if you would like the content to be rendered in HTML format (by default, the API returns the raw text that the user entered)",
            "required":"Optional",
            "example":"`True` or `False`"
        },
        {
            "argument":"client_gravatar",
            "description":"The `client_gravatar` field is set to `True` if clients can compute their own gravatars. Default is `False`.",
            "required":"Optional",
            "example":"`True` or `False`"
        },
        {
            "argument":"event_types",
            "description":"A JSON-encoded array indicating which types of events you're interested in. Values that you might find useful include: <br/> <br/> * **messages** (messages), <br/> * **subscriptions** (changes in your subscriptions), <br/> * **realm_user** (changes in the list of users in your realm), and <br/> * **pointer** (changes in your pointer). <br/> <br/> If you do not specify this argument, you will receive all events, and have to filter out the events not relevant to your client in your client code. For most applications, one is only interested in messages, so one specifies: `event_types=['message']`",
            "required":"Optional",
            "example":"event_types=['message']"
        },
        {
            "argument":"all_public_streams",
            "description":"Set to `True` if you would like to receive events that occur within all public streams. Default is `None`.",
            "required":"Optional",
            "example":"`True` or `False`"
        },
        {
            "argument":"include_subscribers",
            "description":"Set to `True` if you would like to receive events that include the subscribers for each stream. Default is `False`.",
            "required":"Optional",
            "example":"`True` or `False`"
        },
        {
            "argument":"fetch_event_types",
            "description":"Same as the `event_types` argument except that the values in `fetch_event_types` are used to fetch initial data. If `fetch_event_types` is not provided, `event_types` is used and if `event_types` is not provided, this argument defaults to `None`.",
            "required":"Optional",
            "example":"event_types=['message']"
        },
        {
            "argument":"narrow",
            "description":"A JSON-encoded array of length 2 indicating the narrow for which you'd like to receive events for. For instance, to receive events for the stream `Denmark`, you would specify `narrow=['stream', 'Denmark']`. Another example is `narrow=['is', 'private']` for private messages. Default is `[]`.",
            "required":"Optional",
            "example":"narrow=['stream', 'Denmark']"
        }
    ]
}