getprofiles

Documentation

Index

• type FieldsUpdaterFunc
  • func (f FieldsUpdaterFunc) Apply(fields url.Values)
• type Param
  • func WithDefaultPageSize() Param
  • func WithFields(fieldName ...string) Param
  • func WithPageSize(pageSize int) Param

Types

type FieldsUpdaterFunc

type FieldsUpdaterFunc func(url.Values)

FieldsUpdaterFunc is a type that wraps a function that updates URL query parameters.

func (FieldsUpdaterFunc) Apply

func (f FieldsUpdaterFunc) Apply(fields url.Values)

Apply calls the underlying function to update the URL query parameters.

type Param

type Param interface {
	Apply(fields url.Values)
}

Param is an interface that any parameter type should implement. It provides a method to apply the parameter as a query parameter.

func WithDefaultPageSize

func WithDefaultPageSize() Param

WithDefaultPageSize returns a parameter that sets the page size to its default value.

func WithFields

func WithFields(fieldName ...string) Param

WithFields returns a parameter that sets the specific fields to be retrieved for the profile. It accepts a variable number of field names and constructs the appropriate query parameter.

func WithPageSize

func WithPageSize(pageSize int) Param

WithPageSize returns a parameter that sets the page size for the request. It ensures that the page size is within the allowed range.