Meetings¶
- model.GetMeeting(meetingId)¶
- Returns:
the meeting with the specified meetingId or null if the meeting does not exist
- Return type:
object
- Parameters:
meetingId (int) –
- model.GetMeetingIdByDateTime(orgId, meetingtime, createIfNotExists=true)¶
- Returns:
the meetingId or None if the meeting does not exist and should not be created
- Return type:
int
- Parameters:
orgId (int) –
meetingtime (timestamp) – A Unix-style timestamp in seconds since Epoch, UTC
createIfNotExists (bool) – specify whether a meeting should be created if one does not exist with the specified properties
- model.GetMeetingIdByDateTime(orgId, meetingDate, createIfNotExists=true)¶
- Returns:
the meetingId or None if the meeting does not exist and should not be created
- Return type:
int
- Parameters:
orgId (int) –
meetingDate (datetime) – The DateTime for the start of the meeting, in the local timezone of the church
createIfNotExists (bool) – specify whether a meeting should be created if one does not exist with the specified properties
- model.AddExtraValueMeeting(meetingId, field, value)¶
- Parameters:
meetingId (int) – The meetingId for the meeting to which the extra value should be added
field (str) – The name of the extra value to add/edit
value (str) – The value for the extra value
This function either will add an extra value with the specified name and value or if an extra value of that name already exists on the meeting, will set the value as specified.
- model.DeleteExtraValueMeeting(meetingId, field)¶
- Returns:
the number of extra values deleted
- Return type:
int
- Parameters:
meetingId (int) – The meetingId for the meeting from which the extra values should be removed
field (str) – The name of the extra value to remove
- model.ExtraValueMeeting(meetingId, field)¶
- Returns:
the value of the specified extra value
- Return type:
str
- Parameters:
meetingId (int) – The meetingId of the meeting with the extra value whose value you are retrieving
field (str) – The name of the extra value whose value you are retrieving
- model.MeetingDidNotMeet(meetingId, didNotMeet=null)¶
- Returns:
the value to which DidNotMeet was set or null if the meeting was not found
- Return type:
bool
- Parameters:
meetingId (int) – The meetingId of the meeting for which you are setting the DidNotMeet flag
didNotMeet (bool) –
- model.EditCommitment(meetingId, peopleId, commitment)¶
- Parameters:
meetingId (int) – The meetingId of the meeting on which you are editing a commitment
peopleId (int) – The PeopleId of the person for whom you are editing a commitment
commitment (str) – String indicating commitment. One of: Attending, Regrets, Find Sub, Sub Found, Substitute, Uncommitted, all case-insensitive. If the string is not recognized, no changes will be made.
Latest Update |
11/11/2021 |
Added this article.