Documentation
¶
Index ¶
- type ContactMethod
- type Metadata
- type Store
- func (s *Store) Create(ctx context.Context, dbtx gadb.DBTX, c *ContactMethod) (*ContactMethod, error)
- func (s *Store) Delete(ctx context.Context, dbtx gadb.DBTX, ids ...string) error
- func (s *Store) DisableByDest(ctx context.Context, dbtx gadb.DBTX, dest gadb.DestV1) error
- func (s *Store) EnableByDest(ctx context.Context, dbtx gadb.DBTX, dest gadb.DestV1) error
- func (s *Store) FindAll(ctx context.Context, dbtx gadb.DBTX, userID string) ([]ContactMethod, error)
- func (s *Store) FindDestByID(ctx context.Context, tx gadb.DBTX, id uuid.UUID) (gadb.DestV1, error)
- func (s *Store) FindMany(ctx context.Context, dbtx gadb.DBTX, ids []string) ([]ContactMethod, error)
- func (s *Store) FindOne(ctx context.Context, dbtx gadb.DBTX, id uuid.UUID) (*ContactMethod, error)
- func (s *Store) MetadataByDest(ctx context.Context, dbtx gadb.DBTX, dest gadb.DestV1) (*Metadata, error)
- func (s *Store) SetCarrierV1MetadataByDest(ctx context.Context, dbtx gadb.DBTX, dest gadb.DestV1, newM *Metadata) error
- func (s *Store) Update(ctx context.Context, dbtx gadb.DBTX, c *ContactMethod) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContactMethod ¶
type ContactMethod struct {
ID uuid.UUID
Name string
Dest gadb.DestV1
Disabled bool
UserID string
Pending bool
StatusUpdates bool
// contains filtered or unexported fields
}
ContactMethod stores the information for contacting a user.
func (ContactMethod) LastTestVerifyAt ¶ added in v0.26.0
func (c ContactMethod) LastTestVerifyAt() time.Time
LastTestVerifyAt will return the timestamp of the last test/verify request.
func (ContactMethod) Normalize ¶
func (c ContactMethod) Normalize(ctx context.Context, reg *nfydest.Registry) (*ContactMethod, error)
Normalize will validate and 'normalize' the ContactMethod -- such as making email lower-case and setting carrier to "" (for non-phone types).
type Metadata ¶ added in v0.25.0
type Metadata struct {
FetchedAt time.Time `json:"-"`
CarrierV1 struct {
UpdatedAt time.Time
Name string
Type string
MobileNetworkCode string
MobileCountryCode string
}
}
Metadata stores information about a contact method.
func (Metadata) MarshalJSON ¶ added in v0.25.0
MarshalJSON implements `json.Marshaler`. It is used to allow `omitempty` behavior with embedded structs.
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store implements the lookup and management of ContactMethods against a *sql.Store backend.
func (*Store) Create ¶ added in v0.32.0
func (s *Store) Create(ctx context.Context, dbtx gadb.DBTX, c *ContactMethod) (*ContactMethod, error)
CreateTx inserts the new ContactMethod into the database. A new ID is always created.
func (*Store) Delete ¶
Delete removes the ContactMethod from the database using the provided ID within a transaction.
func (*Store) DisableByDest ¶ added in v0.33.0
func (*Store) EnableByDest ¶ added in v0.33.0
func (*Store) FindAll ¶
func (s *Store) FindAll(ctx context.Context, dbtx gadb.DBTX, userID string) ([]ContactMethod, error)
FindAll finds all contact methods from the database associated with the given user ID.
func (*Store) FindDestByID ¶ added in v0.33.0
func (*Store) FindMany ¶
func (s *Store) FindMany(ctx context.Context, dbtx gadb.DBTX, ids []string) ([]ContactMethod, error)
FindMany will fetch all contact methods matching the given ids.
func (*Store) FindOne ¶
FindOneTx finds the contact method from the database using the provided ID within a transaction.
Source Files