Skip to main content

​
Overview

The Family struct represents a family unit within the church congregation. A family groups related members together, providing a household-level view for ministry planning, pastoral care, and demographic analysis.

​
Type Definition

public struct Family: Codable, Equatable, Sendable

​
Properties

​
id
FamilyID
required
Unique identifier for this family unit.
​
familyName
String?
The family name (e.g., “Smith Family”, “Johnson Household”).
​
createdDate
Date?
Date when this family record was created.
​
lastModifiedDate
Date?
Date when this family record was last modified.
​
headOfFamily
MemberID?
The member ID of the head of this family.
​
address
String?
The primary address for this family.
​
homePhone
String?
The home phone number for this family.
​
notes
String?
Optional notes about this family.

​
Initializer

public init(
    id: FamilyID,
    familyName: String? = nil,
    createdDate: Date? = nil,
    lastModifiedDate: Date? = nil,
    headOfFamily: MemberID? = nil,
    address: String? = nil,
    homePhone: String? = nil,
    notes: String? = nil
)

​
Parameters

  • id: Unique identifier for the family
  • familyName: The family name
  • createdDate: Date when the record was created
  • lastModifiedDate: Date when the record was last modified
  • headOfFamily: Member ID of the head of family
  • address: Primary address for the family
  • homePhone: Home phone number
  • notes: Optional notes about the family

​
Example Usage

​
Creating a Family

let family = Family(
    id: FamilyID(rawValue: "FAM001")!,
    familyName: "Smith Family",
    headOfFamily: MemberID(rawValue: "TKT1234")!,
    address: "123 Main Street",
    homePhone: "555-0123"
)

print("Family: \(family.familyName ?? "Unknown")")
print("Address: \(family.address ?? "Not provided")")

​
Fetching a Family

let congregation = CongregationKit(auth: auth)
let family = try await congregation.families.fetch(id: familyId)

if let headId = family.headOfFamily {
    let head = try await congregation.members.fetch(id: headId)
    print("Head of household: \(head.memberName ?? "Unknown")")
}

​
Updating Family Information

let updatedFamily = Family(
    id: existingFamily.id,
    familyName: existingFamily.familyName,
    headOfFamily: existingFamily.headOfFamily,
    address: "456 New Address",
    homePhone: existingFamily.homePhone
)

let saved = try await congregation.families.updateFamily(updatedFamily)
print("Family updated: \(saved.address ?? "")")

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us