# family.pardy.familytime.settings

> Published by [pardy.at](https://lexicon.garden/identity/did:plc:dp7v5b5kejmmzzpwmqyf5wj6)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:dp7v5b5kejmmzzpwmqyf5wj6/family.pardy.familytime.settings)
- [Documentation](https://lexicon.garden/lexicon/did:plc:dp7v5b5kejmmzzpwmqyf5wj6/family.pardy.familytime.settings/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:dp7v5b5kejmmzzpwmqyf5wj6/family.pardy.familytime.settings/examples)

## Definitions

### `family.pardy.familytime.settings#friend`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | No | If they send from an atproto account. |
| `emoji` | `string` | Yes |  |
| `handle` | `string` (handle) | No |  |
| `id` | `string` | Yes | Stable id notes use to name the sender. |
| `name` | `string` | Yes |  |
| `phone` | `string` | No | E.164 mobile number, if they send by text or WhatsApp. Lives only here (parents-only board space). |

### `family.pardy.familytime.settings#location`

**Type**: `object`

Coordinates are decimal strings: the AT data model has no floats.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `latitude` | `string` | Yes |  |
| `longitude` | `string` | Yes |  |
| `name` | `string` | Yes |  |

### `family.pardy.familytime.settings`

**Type**: `record`

The board's settings, in the board space (rkey 'self'). Any parent may write their own copy; the newest updatedAt wins. 'members' is the family list and the access grant for the family's spaces: who is on the board and as what. The spaces name Family Time as their managing app, which answers who may read and write from it, and it only acts for accounts listed here. The space owner is always a parent.

**Key**: `literal:self`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes |  |
| `day` | `object` | No | Default start and end of the day (HH:MM) for planning. |
| `display` | `object` | No | The wall's screen: screensaver after saverMinutes idle; dimmer during quiet hours; optionally locked during quiet hours (the wall PIN itself is kept on the server, not here). |
| `friends` | `array` | No | Family and friends outside the household who may send notes (and nothing else). |
| `location` | `ref` → `#location` | No |  |
| `members` | `array` | Yes |  |
| `name` | `string` | Yes |  |
| `theme` | `string` (at-uri) | No | The home's default family.pardy.design.theme. |
| `themes` | `array` | No | Themes people can pick on the wall. |
| `timezone` | `string` | Yes | IANA time zone. |
| `units` | `string` | No |  |
| `updatedAt` | `string` (datetime) | Yes |  |

### `family.pardy.familytime.settings#member`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `color` | `string` | Yes |  |
| `did` | `string` (did) | Yes |  |
| `emoji` | `string` | Yes |  |
| `handle` | `string` (handle) | No |  |
| `name` | `string` | Yes |  |
| `role` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "friend": {
      "properties": {
        "did": {
          "description": "If they send from an atproto account.",
          "format": "did",
          "type": "string"
        },
        "emoji": {
          "maxLength": 32,
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "id": {
          "description": "Stable id notes use to name the sender.",
          "maxLength": 64,
          "type": "string"
        },
        "name": {
          "maxLength": 40,
          "type": "string"
        },
        "phone": {
          "description": "E.164 mobile number, if they send by text or WhatsApp. Lives only here (parents-only board space).",
          "maxLength": 20,
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "emoji"
      ],
      "type": "object"
    },
    "location": {
      "description": "Coordinates are decimal strings: the AT data model has no floats.",
      "properties": {
        "latitude": {
          "maxLength": 16,
          "type": "string"
        },
        "longitude": {
          "maxLength": 16,
          "type": "string"
        },
        "name": {
          "maxLength": 100,
          "type": "string"
        }
      },
      "required": [
        "name",
        "latitude",
        "longitude"
      ],
      "type": "object"
    },
    "main": {
      "description": "The board's settings, in the board space (rkey 'self'). Any parent may write their own copy; the newest updatedAt wins. 'members' is the family list and the access grant for the family's spaces: who is on the board and as what. The spaces name Family Time as their managing app, which answers who may read and write from it, and it only acts for accounts listed here. The space owner is always a parent.",
      "key": "literal:self",
      "record": {
        "properties": {
          "createdAt": {
            "format": "datetime",
            "type": "string"
          },
          "day": {
            "description": "Default start and end of the day (HH:MM) for planning.",
            "properties": {
              "bed": {
                "maxLength": 5,
                "type": "string"
              },
              "wake": {
                "maxLength": 5,
                "type": "string"
              }
            },
            "type": "object"
          },
          "display": {
            "description": "The wall's screen: screensaver after saverMinutes idle; dimmer during quiet hours; optionally locked during quiet hours (the wall PIN itself is kept on the server, not here).",
            "properties": {
              "lock": {
                "type": "boolean"
              },
              "quietEnd": {
                "maxLength": 5,
                "type": "string"
              },
              "quietStart": {
                "maxLength": 5,
                "type": "string"
              },
              "saverMinutes": {
                "maximum": 120,
                "minimum": 1,
                "type": "integer"
              }
            },
            "type": "object"
          },
          "friends": {
            "description": "Family and friends outside the household who may send notes (and nothing else).",
            "items": {
              "ref": "#friend",
              "type": "ref"
            },
            "maxLength": 50,
            "type": "array"
          },
          "location": {
            "ref": "#location",
            "type": "ref"
          },
          "members": {
            "items": {
              "ref": "#member",
              "type": "ref"
            },
            "maxLength": 32,
            "type": "array"
          },
          "name": {
            "maxLength": 100,
            "type": "string"
          },
          "theme": {
            "description": "The home's default family.pardy.design.theme.",
            "format": "at-uri",
            "type": "string"
          },
          "themes": {
            "description": "Themes people can pick on the wall.",
            "items": {
              "format": "at-uri",
              "type": "string"
            },
            "maxLength": 50,
            "type": "array"
          },
          "timezone": {
            "description": "IANA time zone.",
            "maxLength": 64,
            "type": "string"
          },
          "units": {
            "knownValues": [
              "fahrenheit",
              "celsius"
            ],
            "type": "string"
          },
          "updatedAt": {
            "format": "datetime",
            "type": "string"
          }
        },
        "required": [
          "name",
          "timezone",
          "members",
          "createdAt",
          "updatedAt"
        ],
        "type": "object"
      },
      "type": "record"
    },
    "member": {
      "properties": {
        "color": {
          "maxLength": 32,
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "emoji": {
          "maxGraphemes": 2,
          "maxLength": 32,
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "name": {
          "maxLength": 48,
          "type": "string"
        },
        "role": {
          "knownValues": [
            "parent",
            "kid"
          ],
          "type": "string"
        }
      },
      "required": [
        "did",
        "role",
        "name",
        "emoji",
        "color"
      ],
      "type": "object"
    }
  },
  "id": "family.pardy.familytime.settings",
  "lexicon": 1
}
```