File: /var/www/vhost/disk-apps/pwa.sports-crowd.com/node_modules/@capacitor/dialog/dist/docs.json
{
"api": {
"name": "DialogPlugin",
"slug": "dialogplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "alert",
"signature": "(options: AlertOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "AlertOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "1.0.0"
}
],
"docs": "Show an alert dialog",
"complexTypes": [
"AlertOptions"
],
"slug": "alert"
},
{
"name": "prompt",
"signature": "(options: PromptOptions) => Promise<PromptResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "PromptOptions"
}
],
"returns": "Promise<PromptResult>",
"tags": [
{
"name": "since",
"text": "1.0.0"
}
],
"docs": "Show a prompt dialog",
"complexTypes": [
"PromptResult",
"PromptOptions"
],
"slug": "prompt"
},
{
"name": "confirm",
"signature": "(options: ConfirmOptions) => Promise<ConfirmResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ConfirmOptions"
}
],
"returns": "Promise<ConfirmResult>",
"tags": [
{
"name": "since",
"text": "1.0.0"
}
],
"docs": "Show a confirmation dialog",
"complexTypes": [
"ConfirmResult",
"ConfirmOptions"
],
"slug": "confirm"
}
],
"properties": []
},
"interfaces": [
{
"name": "AlertOptions",
"slug": "alertoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "title",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Title of the dialog.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "message",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Message to show on the dialog.",
"complexTypes": [],
"type": "string"
},
{
"name": "buttonTitle",
"tags": [
{
"text": "\"OK\"",
"name": "default"
},
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Text to use on the action button.",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "PromptResult",
"slug": "promptresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "value",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Text entered on the prompt.",
"complexTypes": [],
"type": "string"
},
{
"name": "cancelled",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Whether if the prompt was canceled or accepted.",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "PromptOptions",
"slug": "promptoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "title",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Title of the dialog.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "message",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Message to show on the dialog.",
"complexTypes": [],
"type": "string"
},
{
"name": "okButtonTitle",
"tags": [
{
"text": "\"OK\"",
"name": "default"
},
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Text to use on the positive action button.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "cancelButtonTitle",
"tags": [
{
"text": "\"Cancel\"",
"name": "default"
},
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Text to use on the negative action button.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "inputPlaceholder",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Placeholder text for hints.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "inputText",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Prepopulated text.",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "ConfirmResult",
"slug": "confirmresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "value",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "true if the positive button was clicked, false otherwise.",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "ConfirmOptions",
"slug": "confirmoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "title",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Title of the dialog.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "message",
"tags": [
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Message to show on the dialog.",
"complexTypes": [],
"type": "string"
},
{
"name": "okButtonTitle",
"tags": [
{
"text": "\"OK\"",
"name": "default"
},
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Text to use on the positive action button.",
"complexTypes": [],
"type": "string | undefined"
},
{
"name": "cancelButtonTitle",
"tags": [
{
"text": "\"Cancel\"",
"name": "default"
},
{
"text": "1.0.0",
"name": "since"
}
],
"docs": "Text to use on the negative action button.",
"complexTypes": [],
"type": "string | undefined"
}
]
}
],
"enums": [],
"typeAliases": [],
"pluginConfigs": []
}