170 lines
4.6 KiB
JSON
170 lines
4.6 KiB
JSON
|
{
|
||
|
"name": "PamContext",
|
||
|
"module": "Quickshell.Services.Pam",
|
||
|
"type": "class",
|
||
|
"super": {
|
||
|
"type": "qt",
|
||
|
"module": "qml.QtQml",
|
||
|
"name": "QtObject"
|
||
|
},
|
||
|
"description": "Connection to pam.",
|
||
|
"details": "Connection to pam. See [the module documentation](../) for pam configuration advice.\n",
|
||
|
"properties": {
|
||
|
"user": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "string"
|
||
|
},
|
||
|
"details": "The user to authenticate as. If unset the current user will be used.\n\nThis property may not be set while TYPE99Vactive99Tprop99TYPE is true.\n"
|
||
|
},
|
||
|
"responseRequired": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "bool"
|
||
|
},
|
||
|
"details": "If pam currently wants a response.\n\nResponses can be returned with the TYPE99Vrespond99Tfunc99TYPE function.\n",
|
||
|
"flags": [
|
||
|
"readonly"
|
||
|
]
|
||
|
},
|
||
|
"messageIsError": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "bool"
|
||
|
},
|
||
|
"details": "If the last message should be shown as an error.\n",
|
||
|
"flags": [
|
||
|
"readonly"
|
||
|
]
|
||
|
},
|
||
|
"active": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "bool"
|
||
|
},
|
||
|
"details": "If the pam context is actively performing an authentication.\n\nSetting this value behaves exactly the same as calling TYPE99Vstart99Tfunc99TYPE and TYPE99Vabort99Tfunc99TYPE.\n"
|
||
|
},
|
||
|
"configDirectory": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "string"
|
||
|
},
|
||
|
"details": "The pam configuration directory to use. Defaults to \"/etc/pam.d\".\n\nThe configuration directory is resolved relative to the current file if not an absolute path.\n\nThis property may not be set while TYPE99Vactive99Tprop99TYPE is true.\n"
|
||
|
},
|
||
|
"message": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "string"
|
||
|
},
|
||
|
"details": "The last message sent by pam.\n",
|
||
|
"flags": [
|
||
|
"readonly"
|
||
|
]
|
||
|
},
|
||
|
"config": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "string"
|
||
|
},
|
||
|
"details": "The pam configuration to use. Defaults to \"login\".\n\nThe configuration should name a file inside TYPE99VconfigDirectory99Tprop99TYPE.\n\nThis property may not be set while TYPE99Vactive99Tprop99TYPE is true.\n"
|
||
|
},
|
||
|
"responseVisible": {
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "bool"
|
||
|
},
|
||
|
"details": "If the user's response should be visible. Only valid when TYPE99VresponseRequired99Tprop99TYPE is true.\n",
|
||
|
"flags": [
|
||
|
"readonly"
|
||
|
]
|
||
|
}
|
||
|
},
|
||
|
"functions": [
|
||
|
{
|
||
|
"ret": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "void"
|
||
|
},
|
||
|
"name": "abort",
|
||
|
"id": "abort",
|
||
|
"details": "Abort a running authentication session.\n",
|
||
|
"params": []
|
||
|
},
|
||
|
{
|
||
|
"ret": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "void"
|
||
|
},
|
||
|
"name": "respond",
|
||
|
"id": "respond",
|
||
|
"details": "Respond to pam.\n\nMay not be called unless TYPE99VresponseRequired99Tprop99TYPE is true.\n",
|
||
|
"params": [
|
||
|
{
|
||
|
"name": "response",
|
||
|
"type": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "string"
|
||
|
}
|
||
|
}
|
||
|
]
|
||
|
},
|
||
|
{
|
||
|
"ret": {
|
||
|
"type": "qt",
|
||
|
"module": "qml",
|
||
|
"name": "bool"
|
||
|
},
|
||
|
"name": "start",
|
||
|
"id": "start",
|
||
|
"details": "Start an authentication session. Returns if the session was started successfully.\n",
|
||
|
"params": []
|
||
|
}
|
||
|
],
|
||
|
"signals": {
|
||
|
"completed": {
|
||
|
"name": "completed",
|
||
|
"details": "Emitted whenever authentication completes.\n",
|
||
|
"params": [
|
||
|
{
|
||
|
"name": "result",
|
||
|
"type": {
|
||
|
"type": "local",
|
||
|
"module": "Quickshell.Services.Pam",
|
||
|
"name": "PamResult"
|
||
|
}
|
||
|
}
|
||
|
]
|
||
|
},
|
||
|
"pamMessage": {
|
||
|
"name": "pamMessage",
|
||
|
"details": "Emitted whenever pam sends a new message, after the change signals for\n`message`, `messageIsError`, and `responseRequired`.\n",
|
||
|
"params": []
|
||
|
},
|
||
|
"error": {
|
||
|
"name": "error",
|
||
|
"details": "Emitted if pam fails to perform authentication normally.\n\nA `completed(PamResult.Error)` will be emitted after this event.\n",
|
||
|
"params": [
|
||
|
{
|
||
|
"name": "error",
|
||
|
"type": {
|
||
|
"type": "local",
|
||
|
"module": "Quickshell.Services.Pam",
|
||
|
"name": "PamError"
|
||
|
}
|
||
|
}
|
||
|
]
|
||
|
}
|
||
|
},
|
||
|
"variants": {}
|
||
|
}
|