Skip to main content

SchedulerJobStepConnection

Type

Represents a connection to the scheduler.

Properties​

IsConnected​

This item is read only and cannot be modified. Read Only
</>
SchedulerJobStepConnection.IsConnected: boolean

If true, this connection is being actively fired, otherwise it was disconnected.

IsEnabled​

This item is read only and cannot be modified. Read Only
</>
SchedulerJobStepConnection.IsEnabled: boolean

If true, this connection can be fired, otherwise it was temporarily disabled with :Disable()

Functions​

Enable​

</>
SchedulerJobStepConnection:Enable() → ()

Enables the connection to be fired, if disabled with :Disable()

Disable​

</>
SchedulerJobStepConnection:Disable() → ()

Prevents this connection from being temporarily fired, can be re-enabled with :Enable()

Disconnect​

</>
SchedulerJobStepConnection:Disconnect() → ()

Disconnects this connection which stops it from being fired. This will make this connection unusable in the future.

Show raw api
{
    "functions": [
        {
            "name": "Enable",
            "desc": "Enables the connection to be fired, if disabled with `:Disable()`\n\n    ",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 32,
                "path": "impl/Types/SchedulerJobStepConnection.luau"
            }
        },
        {
            "name": "Disable",
            "desc": "Prevents this connection from being temporarily fired, can be re-enabled with `:Enable()`\n\n    ",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 41,
                "path": "impl/Types/SchedulerJobStepConnection.luau"
            }
        },
        {
            "name": "Disconnect",
            "desc": "Disconnects this connection which stops it from being fired.\nThis will make this connection unusable in the future.\n\n    ",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 51,
                "path": "impl/Types/SchedulerJobStepConnection.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "IsConnected",
            "desc": "If true, this connection is being actively fired, otherwise it was disconnected.\n\n    ",
            "lua_type": "boolean",
            "readonly": true,
            "source": {
                "line": 16,
                "path": "impl/Types/SchedulerJobStepConnection.luau"
            }
        },
        {
            "name": "IsEnabled",
            "desc": "If true, this connection can be fired, otherwise it was temporarily disabled with `:Disable()`\n\n    ",
            "lua_type": "boolean",
            "readonly": true,
            "source": {
                "line": 25,
                "path": "impl/Types/SchedulerJobStepConnection.luau"
            }
        }
    ],
    "types": [],
    "name": "SchedulerJobStepConnection",
    "desc": "Represents a connection to the scheduler.",
    "tags": [
        "Type"
    ],
    "source": {
        "line": 7,
        "path": "impl/Types/SchedulerJobStepConnection.luau"
    }
}