Appearance
Domain types (SB_*)
~276 public SB_* types the facade returns/accepts. Grouped index:
- User / auth —
SB_UserProfile,SB_UserDemographics,SB_UserAppSettings,SB_Session,SB_SDKCredentials,SB_RegisterUserOutcome(+SB_ServiceErrorCode),SB_ChangePasswordOutcome,SB_EmailAvailabilityOutcome,SB_UpdateUserProfileOutcome,SB_RequestPasswordResetOutcome,SB_AgreementCheck,SB_Gender,SB_UserProfileUpdate,SB_ValidateAccountRequirementsRequest,SB_ValidateAccountRequirementsResult,SB_OrganizationMembership,SB_OrganizationMemberStatus,SB_OrgMembership. - Devices / Bluetooth —
SB_PairedDeviceState,SB_DiscoveredDevice,SB_PairingState,SB_PairingFailure,SB_BSDeviceModel,SB_BluetoothDeviceType,SB_ConnectionStage,SB_BluetoothResetState,SB_BatteryLevel,SB_DeviceLinkFailure,SB_SyncResult,SB_FirmwareInfo,SB_FirmwareUpdateError,SB_FirmwareVersionPacket,SB_DeviceResetResult,SB_ServerDeviceName. - Recording —
SB_RecordingState,SB_RecordingFinalizationPhase,SB_RecordingMetaType,SB_RecordingSession,SB_RecordingInfo,SB_RecordingCustomization,SB_PersistedRecording,SB_ActiveRecordingInfo,SB_RecordingError,SB_RawSensorDataLogging,SB_SpotCheckDetails,SB_SubmitFinishedRecordingResult,SB_LatestBookend,SB_BiometricRecordResult,SB_ExerciseZoneAttributes/SB_HRZone(SB_HREffortZonedeprecated, SB-2355). - Sleep —
SB_SleepItem,SB_SleepDetailDay,SB_SleepDetailAggregated,SB_SleepStages,SB_SleepStage,SB_SleepBiometrics,SB_SleepScore(+factors/penalties/sections),SB_SleepPosition,SB_SleepDisturbances,SB_SleepApneaInfo,SB_SleepAccounting,SB_SleepDebt*,SB_SleepMetric,SB_SleepWriteError,SB_DetectedSleep. (~40 types)SB_SleepBedtimeRecommendationcarries no calibration block — a recommendation only exists once the user is out of the calibration window, soSB_SleepDetailDay.bedtimeRecommendationisnullwhile the server is still calibrating rather than a recommendation with empty times. Hosts render nothing for that state.SB_CalibrationInfo(totalDays/pendingDays) is still surfaced onSB_SleepAccounting, which does render a calibrating state. It carries nomessage: the server sends a pre-rendered sentence for this phase, but the SDK drops it so the copy — and its localization — stays the host app's to own, built from the two day counts. - Activity / workout / steps —
SB_TrainedActivity,SB_ActivityRecordingList,SB_ActivitySummary,SB_WorkoutDetail,SB_WorkoutTimelineResult,SB_WorkoutSummaryMetric,SB_ModifyAction,SB_ModifyOutcome,SB_ExerciseZones,SB_StepsTrending,SB_StepMetric,SB_StepMetricType,SB_ActivityDetail,SB_ActivityScore,SB_SummaryGranularity,SB_PageFetchDirection,SB_LocalRecordingEntry,SB_WLSRecordingType,SB_WorkoutRecordingInfo(+SB_OngoingWorkoutProgram). - Biometrics / metrics — one shared daily family
SB_BiometricDailyTrending(+SB_BiometricDailyGraph,SB_BiometricPoint,SB_BiometricValueType) for HR / HRV / RR / SpO2 (§5.10), plus the per-metric range graph & trending families (SB_HRRange*,SB_HRVRange*,SB_SpO2Range*,SB_RRRange*);SB_ImprovementRating; live per-sample stream payloadsSB_HeartRateSample/SB_HrvSample/SB_RespiratoryRateSample/SB_SnrSample/SB_BbiSample/SB_PpgSample/SB_EcgSample(§3.2);SB_LiveMetric;SB_HRMData(+SB_HRMCategory);SB_TimeValuePoint,SB_DateValuePoint,SB_BarGraph,SB_CalorieMetric,SB_CaloriesTrending,SB_CardioStats;SB_SkinTemperature(+SB_SkinTemperature.Point; reusesSB_HRPointType) — local-first day summary fromgetSkinTemperature(date)(§5.13), all Celsius; each point tagged ASLEEP / AWAKE.SB_DailyTemperatureTrending(reusesSB_SkinTemperature.Point) — the server's day fromfetchDailyTemperature(date);SB_TemperatureRangeTrending(+SB_TemperatureTrendingGraph; reusesSB_WMYGraph) — the sleep + daily W/M/Y series fromfetchRangeTemperature(§5.13). All Celsius.SB_SpO2(+SB_SpO2.Point; reusesSB_HRPointType) — on-device day summary fromgetSpO2(date), in percent; each point tagged ASLEEP / AWAKE (SB-1433).SB_BiometricBaselines(+SB_BiometricBaseline) — a day's resting HR / HRV / respiratory rate / SpO2 against their 30-day baselines, fromgetBiometricBaselines(date)(§5.8.1).SB_DevicePacketBatch,SB_DeviceDataStream(+csvHeader) — one page of a band's raw device data as per-stream CSV, fromgetDevicePacketsin offline mode (SB-2630).SB_StressIndexDay(+SB_StressIndexDay.Point; reusesSB_HRPointType) — a day's continuous stress index fromgetStressIndex(date)/fetchStressIndex(date)(§5.9.1): points plus SDK-calculatedlatest/min/max/sleepAverage/daytimeAverage.SB_HRDataPoints(+SB_HRDataPoint,SB_HRPointType{AWAKE,ASLEEP}) — local-first day HR fromgetHRPoints(date)(§5.2); the container computesaverageHR/lowestHR/highestHRon the fly and carries a storedrestingHR(all nullable, never a misleading 0).SB_HRVDataPoints(+SB_HRVDataPoint; reusesSB_HRPointType) — local-first day HRV fromgetHRVPoints(date)(§5.3); the container computesaverageHRV/lowestHRV/highestHRVon the fly and carries a storedrestingHRV(all nullable, never a misleading 0).SB_RRDataPoints(+SB_RRDataPoint; reusesSB_HRPointType) — local-first day RR fromgetRRPoints(date)(§5.4); the container computesaverageRR/lowestRR/highestRRon the fly and carries a storedrestingRR(all nullable, never a misleading 0).SB_StepsDataPoints(+SB_StepsDataPoint,SB_StepsHourBucket) — local-first day steps fromgetStepsPoints(date)(§5.5); the container computes day totalstotalSteps/totalDistanceMeters/totalCalories/totalActiveSeconds(active duration) +hourlyBucketson the fly. No awake/asleep tag and no min/avg/max (steps are counts); totals are non-null (default 0).SB_CaloriesDataPoints(+SB_CaloriesDataPoint,SB_CaloriesHourBucket) — local-first day calories fromgetCaloriesPoints(date)(§5.6); a faithful local recreation of the server's five calorie metrics. The container computestotalActiveCalories(ring) /totalStepCalories/totalWorkoutCalories/totalCalories(= active + resting) +hourlyBucketson the fly, alongside the constructor'srestingCalories(BMR-based). Each point splits itstotalStepCaloriesintostepCalories+workoutCalories, with a workout minute's workout part recomputed from HR (server parity:active = max(0, step + workout), floored per point). Shares the step rows; no awake/asleep tag, no min/avg/max; totals non-null (default 0). Local-first sleep reuses the server Sleep types above:getSleepDetail(date)(§5.7) returns anSB_SleepDetailDayrebuilt from the on-devicesleep_sessionsrow (stage timeline + metric tiles populated; server-owned score/recommendations/accounting/biometric graphs/positions left empty). - Recovery —
SB_RecoveryRange*,SB_DailyRecovery*,SB_RecoveryScoreFactor/Section. EachSB_RecoveryScoreFactorreports itspercentile(0–100) and a pre-computedscoreValue— the factor's weighted contribution under0.4·HRV + 0.4·RHR + 0.1·Sleep Efficiency + 0.1·Sleep Duration; colors are not returned (the app derives them from the percentile). BothSB_DailyRecoveryTrendingandSB_RecoveryRangeTrendingalso carry the signed-in user'sjoinedDate(from the profile, not the recovery payload) so the app can describe the averaging window. - Dashboard —
SB_DashboardData+ ~20 card/metric types (SB_DashboardMetric,SB_DashboardInsight,SB_DashboardGradientCard,SB_DashboardSleepItem, …). - Insights / population —
SB_NewInsights,SB_InsightItem,SB_InsightFeedback,SB_PopulationInsights(+filters/histogram/radar),SB_PopulationInsightsFilterList,SB_PopulationMetricType,SB_PopulationAgeGroup,SB_PopulationGender,SB_DailyStatsResponse.SB_PopulationInsightsHistogramcarries the numeric insight —insightValue: FloatininsightUnit: SB_PopulationInsightUnit{NONE,MINUTES,MILLISECONDS,PERCENT}andinsightPercentage: Int(share of the population the user beats, 0–100) — so the host can build and localize the insight sentence itself. The server-preformatted EnglishinsightTextis deprecated but still sent; fall back to it wheninsightValue == 0f(proto3 has no presence). - Meditation —
SB_MeditationGraph. - Events / elements —
SB_NotificationElement. - Surveys / agreements —
SB_BriefSurvey(+Question/Answer/Type),SB_AgreementType. - Goals / config —
SB_Goals,SB_AppConfig,CacheStrategy,SB_ViewGranularity. - Errors / results —
SB_InsightError,SB_RecordStage,SB_UnitType. - Top-level config —
SB_Environment(DEVELOPMENT/PRODUCTION),SB_LogLevel(V/D/I/W/E),SB_NetworkStatus(UNREACHABLE/WIFI/CELLULAR/OTHER). - Analytics —
SB_AnalyticsEvent(name+properties: Map<String,String>).