Reference Script Functions Donordrive

DonorDrive script functions

Also on the Cuebot Docs site.

Functions for C# (Cb.Call) and Python (a cb method each, or cb.call). See Script functions for how to use them.

donordrive.getProfile

Gives you the last details Cuebot read from your DonorDrive page, like your goal and how much you raised.

Gives back: id, name, teamName, eventName, goal, raised, donations (how many), isTeam (true/false) and url. null when nothing was read yet.

C#

var answer = await Cb.Call("donordrive.getProfile");

Python

answer = cb.donordrive_get_profile()

donordrive.isConnected

Checks whether Cuebot is watching your DonorDrive (charity) page right now.

Gives back: true while Cuebot is checking your participant or team page, otherwise false.

C#

var answer = await Cb.Call("donordrive.isConnected");

Python

answer = cb.donordrive_is_connected()

donordrive.sendTestEvent

Fakes a DonorDrive event inside Cuebot, so you can test your triggers. Nothing is sent to DonorDrive and it works without a connection.

Value	In Python	What to put in
kind	kind	Optional. Which event: "donation", "incentive" (a donation that picked a reward) or "profile" (your totals went up). Default "donation".

Gives back: true when the test event was sent, false when the kind is unknown.

C#

var answer = await Cb.Call("donordrive.sendTestEvent", new { kind = "donation" });

Python

answer = cb.donordrive_send_test_event(kind="donation")