package fedcm

Import Path
	github.com/chromedp/cdproto/fedcm (on go.dev)

Dependency Relation
	imports 7 packages, and imported by one package

Involved Source Files

	    easyjson.go
	    events.go
	  d fedcm.go
		Package fedcm provides the Chrome DevTools Protocol
		commands, types, and events for the FedCm domain.
		
		This domain allows interacting with the FedCM dialog.
		
		Generated by the cdproto-gen command.

	    types.go
Package-Level Type Names (total 10)

	/* sort by: alphabet | popularity */
	 type Account (struct)
		Account corresponds to IdentityRequestAccount.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#type-Account

		Fields (total 10)
			AccountID string
			Email string
			GivenName string
			IdpConfigURL string
			IdpLoginURL string
			LoginState LoginState
			Name string
			PictureURL string
			PrivacyPolicyURL string
			TermsOfServiceURL string
				// These two are only set if the loginState is signUp

		Methods (total 4)
			( Account) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( Account) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*Account) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*Account) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 Account : github.com/goccy/go-json.Marshaler
			*Account : github.com/goccy/go-json.Unmarshaler
			 Account : github.com/mailru/easyjson.Marshaler
			*Account : github.com/mailru/easyjson.MarshalerUnmarshaler
			*Account : github.com/mailru/easyjson.Unmarshaler
			 Account : encoding/json.Marshaler
			*Account : encoding/json.Unmarshaler

	 type ConfirmIdpLoginParams (struct)
		ConfirmIdpLoginParams only valid if the dialog type is ConfirmIdpLogin.
		Acts as if the user had clicked the continue button.

		Fields (only one)
			DialogID string
		Methods (total 5)
			(*ConfirmIdpLoginParams) Do(ctx context.Context) (err error)
				Do executes FedCm.confirmIdpLogin against the provided context.

			( ConfirmIdpLoginParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ConfirmIdpLoginParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ConfirmIdpLoginParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ConfirmIdpLoginParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.Action
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.CallAction
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.EmulateAction
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.EvaluateAction
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.KeyAction
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.MouseAction
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.NavigateAction
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.PollAction
			*ConfirmIdpLoginParams : github.com/chromedp/chromedp.QueryAction
			 ConfirmIdpLoginParams : github.com/goccy/go-json.Marshaler
			*ConfirmIdpLoginParams : github.com/goccy/go-json.Unmarshaler
			 ConfirmIdpLoginParams : github.com/mailru/easyjson.Marshaler
			*ConfirmIdpLoginParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ConfirmIdpLoginParams : github.com/mailru/easyjson.Unmarshaler
			 ConfirmIdpLoginParams : encoding/json.Marshaler
			*ConfirmIdpLoginParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func ConfirmIdpLogin(dialogID string) *ConfirmIdpLoginParams

	 type DialogType string (basic type)
		DialogType whether the dialog shown is an account chooser or an auto
		re-authentication dialog.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#type-DialogType

		Methods (total 5)
			( DialogType) MarshalEasyJSON(out *jwriter.Writer)
				MarshalEasyJSON satisfies easyjson.Marshaler.

			( DialogType) MarshalJSON() ([]byte, error)
				MarshalJSON satisfies json.Marshaler.

			( DialogType) String() string
				String returns the DialogType as string value.

			(*DialogType) UnmarshalEasyJSON(in *jlexer.Lexer)
				UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

			(*DialogType) UnmarshalJSON(buf []byte) error
				UnmarshalJSON satisfies json.Unmarshaler.

		Implements (at least 9)
			 DialogType : github.com/goccy/go-json.Marshaler
			*DialogType : github.com/goccy/go-json.Unmarshaler
			 DialogType : github.com/mailru/easyjson.Marshaler
			*DialogType : github.com/mailru/easyjson.MarshalerUnmarshaler
			*DialogType : github.com/mailru/easyjson.Unmarshaler
			 DialogType : encoding/json.Marshaler
			*DialogType : encoding/json.Unmarshaler
			 DialogType : expvar.Var
			 DialogType : fmt.Stringer
		As Types Of (total 3)
			const DialogTypeAccountChooser
			const DialogTypeAutoReauthn
			const DialogTypeConfirmIdpLogin

	 type DisableParams (struct)
		DisableParams [no description].

		Methods (total 5)
			(*DisableParams) Do(ctx context.Context) (err error)
				Do executes FedCm.disable against the provided context.

			( DisableParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( DisableParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*DisableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*DisableParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*DisableParams : github.com/chromedp/chromedp.Action
			*DisableParams : github.com/chromedp/chromedp.CallAction
			*DisableParams : github.com/chromedp/chromedp.EmulateAction
			*DisableParams : github.com/chromedp/chromedp.EvaluateAction
			*DisableParams : github.com/chromedp/chromedp.KeyAction
			*DisableParams : github.com/chromedp/chromedp.MouseAction
			*DisableParams : github.com/chromedp/chromedp.NavigateAction
			*DisableParams : github.com/chromedp/chromedp.PollAction
			*DisableParams : github.com/chromedp/chromedp.QueryAction
			 DisableParams : github.com/goccy/go-json.Marshaler
			*DisableParams : github.com/goccy/go-json.Unmarshaler
			 DisableParams : github.com/mailru/easyjson.Marshaler
			*DisableParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*DisableParams : github.com/mailru/easyjson.Unmarshaler
			 DisableParams : encoding/json.Marshaler
			*DisableParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func Disable() *DisableParams

	 type DismissDialogParams (struct)
		DismissDialogParams [no description].

		Fields (total 2)
			DialogID string
			TriggerCooldown bool
		Methods (total 6)
			(*DismissDialogParams) Do(ctx context.Context) (err error)
				Do executes FedCm.dismissDialog against the provided context.

			( DismissDialogParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( DismissDialogParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*DismissDialogParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*DismissDialogParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

			( DismissDialogParams) WithTriggerCooldown(triggerCooldown bool) *DismissDialogParams
				WithTriggerCooldown [no description].

		Implements (at least 16)
			*DismissDialogParams : github.com/chromedp/chromedp.Action
			*DismissDialogParams : github.com/chromedp/chromedp.CallAction
			*DismissDialogParams : github.com/chromedp/chromedp.EmulateAction
			*DismissDialogParams : github.com/chromedp/chromedp.EvaluateAction
			*DismissDialogParams : github.com/chromedp/chromedp.KeyAction
			*DismissDialogParams : github.com/chromedp/chromedp.MouseAction
			*DismissDialogParams : github.com/chromedp/chromedp.NavigateAction
			*DismissDialogParams : github.com/chromedp/chromedp.PollAction
			*DismissDialogParams : github.com/chromedp/chromedp.QueryAction
			 DismissDialogParams : github.com/goccy/go-json.Marshaler
			*DismissDialogParams : github.com/goccy/go-json.Unmarshaler
			 DismissDialogParams : github.com/mailru/easyjson.Marshaler
			*DismissDialogParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*DismissDialogParams : github.com/mailru/easyjson.Unmarshaler
			 DismissDialogParams : encoding/json.Marshaler
			*DismissDialogParams : encoding/json.Unmarshaler
		As Outputs Of (at least 2)
			func DismissDialog(dialogID string) *DismissDialogParams
			func DismissDialogParams.WithTriggerCooldown(triggerCooldown bool) *DismissDialogParams

	 type EnableParams (struct)
		EnableParams [no description].

		Fields (only one)
			DisableRejectionDelay bool
				// Allows callers to disable the promise rejection delay that would normally happen, if this is unimportant to what's being tested. (step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)

		Methods (total 6)
			(*EnableParams) Do(ctx context.Context) (err error)
				Do executes FedCm.enable against the provided context.

			( EnableParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EnableParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EnableParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EnableParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

			( EnableParams) WithDisableRejectionDelay(disableRejectionDelay bool) *EnableParams
				WithDisableRejectionDelay allows callers to disable the promise rejection
				delay that would normally happen, if this is unimportant to what's being
				tested. (step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in).

		Implements (at least 16)
			*EnableParams : github.com/chromedp/chromedp.Action
			*EnableParams : github.com/chromedp/chromedp.CallAction
			*EnableParams : github.com/chromedp/chromedp.EmulateAction
			*EnableParams : github.com/chromedp/chromedp.EvaluateAction
			*EnableParams : github.com/chromedp/chromedp.KeyAction
			*EnableParams : github.com/chromedp/chromedp.MouseAction
			*EnableParams : github.com/chromedp/chromedp.NavigateAction
			*EnableParams : github.com/chromedp/chromedp.PollAction
			*EnableParams : github.com/chromedp/chromedp.QueryAction
			 EnableParams : github.com/goccy/go-json.Marshaler
			*EnableParams : github.com/goccy/go-json.Unmarshaler
			 EnableParams : github.com/mailru/easyjson.Marshaler
			*EnableParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EnableParams : github.com/mailru/easyjson.Unmarshaler
			 EnableParams : encoding/json.Marshaler
			*EnableParams : encoding/json.Unmarshaler
		As Outputs Of (at least 2)
			func Enable() *EnableParams
			func EnableParams.WithDisableRejectionDelay(disableRejectionDelay bool) *EnableParams

	 type EventDialogShown (struct)
		EventDialogShown [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#event-dialogShown

		Fields (total 5)
			Accounts []*Account
			DialogID string
			DialogType DialogType
			Subtitle string
			Title string
				// These exist primarily so that the caller can verify the RP context was used appropriately.

		Methods (total 4)
			( EventDialogShown) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( EventDialogShown) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*EventDialogShown) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*EventDialogShown) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 7)
			 EventDialogShown : github.com/goccy/go-json.Marshaler
			*EventDialogShown : github.com/goccy/go-json.Unmarshaler
			 EventDialogShown : github.com/mailru/easyjson.Marshaler
			*EventDialogShown : github.com/mailru/easyjson.MarshalerUnmarshaler
			*EventDialogShown : github.com/mailru/easyjson.Unmarshaler
			 EventDialogShown : encoding/json.Marshaler
			*EventDialogShown : encoding/json.Unmarshaler

	 type LoginState string (basic type)
		LoginState whether this is a sign-up or sign-in action for this account,
		i.e. whether this account has ever been used to sign in to this RP before.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#type-LoginState

		Methods (total 5)
			( LoginState) MarshalEasyJSON(out *jwriter.Writer)
				MarshalEasyJSON satisfies easyjson.Marshaler.

			( LoginState) MarshalJSON() ([]byte, error)
				MarshalJSON satisfies json.Marshaler.

			( LoginState) String() string
				String returns the LoginState as string value.

			(*LoginState) UnmarshalEasyJSON(in *jlexer.Lexer)
				UnmarshalEasyJSON satisfies easyjson.Unmarshaler.

			(*LoginState) UnmarshalJSON(buf []byte) error
				UnmarshalJSON satisfies json.Unmarshaler.

		Implements (at least 9)
			 LoginState : github.com/goccy/go-json.Marshaler
			*LoginState : github.com/goccy/go-json.Unmarshaler
			 LoginState : github.com/mailru/easyjson.Marshaler
			*LoginState : github.com/mailru/easyjson.MarshalerUnmarshaler
			*LoginState : github.com/mailru/easyjson.Unmarshaler
			 LoginState : encoding/json.Marshaler
			*LoginState : encoding/json.Unmarshaler
			 LoginState : expvar.Var
			 LoginState : fmt.Stringer
		As Types Of (total 2)
			const LoginStateSignIn
			const LoginStateSignUp

	 type ResetCooldownParams (struct)
		ResetCooldownParams resets the cooldown time, if any, to allow the next
		FedCM call to show a dialog even if one was recently dismissed by the user.

		Methods (total 5)
			(*ResetCooldownParams) Do(ctx context.Context) (err error)
				Do executes FedCm.resetCooldown against the provided context.

			( ResetCooldownParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( ResetCooldownParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*ResetCooldownParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*ResetCooldownParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*ResetCooldownParams : github.com/chromedp/chromedp.Action
			*ResetCooldownParams : github.com/chromedp/chromedp.CallAction
			*ResetCooldownParams : github.com/chromedp/chromedp.EmulateAction
			*ResetCooldownParams : github.com/chromedp/chromedp.EvaluateAction
			*ResetCooldownParams : github.com/chromedp/chromedp.KeyAction
			*ResetCooldownParams : github.com/chromedp/chromedp.MouseAction
			*ResetCooldownParams : github.com/chromedp/chromedp.NavigateAction
			*ResetCooldownParams : github.com/chromedp/chromedp.PollAction
			*ResetCooldownParams : github.com/chromedp/chromedp.QueryAction
			 ResetCooldownParams : github.com/goccy/go-json.Marshaler
			*ResetCooldownParams : github.com/goccy/go-json.Unmarshaler
			 ResetCooldownParams : github.com/mailru/easyjson.Marshaler
			*ResetCooldownParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*ResetCooldownParams : github.com/mailru/easyjson.Unmarshaler
			 ResetCooldownParams : encoding/json.Marshaler
			*ResetCooldownParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func ResetCooldown() *ResetCooldownParams

	 type SelectAccountParams (struct)
		SelectAccountParams [no description].

		Fields (total 2)
			AccountIndex int64
			DialogID string
		Methods (total 5)
			(*SelectAccountParams) Do(ctx context.Context) (err error)
				Do executes FedCm.selectAccount against the provided context.

			( SelectAccountParams) MarshalEasyJSON(w *jwriter.Writer)
				MarshalEasyJSON supports easyjson.Marshaler interface

			( SelectAccountParams) MarshalJSON() ([]byte, error)
				MarshalJSON supports json.Marshaler interface

			(*SelectAccountParams) UnmarshalEasyJSON(l *jlexer.Lexer)
				UnmarshalEasyJSON supports easyjson.Unmarshaler interface

			(*SelectAccountParams) UnmarshalJSON(data []byte) error
				UnmarshalJSON supports json.Unmarshaler interface

		Implements (at least 16)
			*SelectAccountParams : github.com/chromedp/chromedp.Action
			*SelectAccountParams : github.com/chromedp/chromedp.CallAction
			*SelectAccountParams : github.com/chromedp/chromedp.EmulateAction
			*SelectAccountParams : github.com/chromedp/chromedp.EvaluateAction
			*SelectAccountParams : github.com/chromedp/chromedp.KeyAction
			*SelectAccountParams : github.com/chromedp/chromedp.MouseAction
			*SelectAccountParams : github.com/chromedp/chromedp.NavigateAction
			*SelectAccountParams : github.com/chromedp/chromedp.PollAction
			*SelectAccountParams : github.com/chromedp/chromedp.QueryAction
			 SelectAccountParams : github.com/goccy/go-json.Marshaler
			*SelectAccountParams : github.com/goccy/go-json.Unmarshaler
			 SelectAccountParams : github.com/mailru/easyjson.Marshaler
			*SelectAccountParams : github.com/mailru/easyjson.MarshalerUnmarshaler
			*SelectAccountParams : github.com/mailru/easyjson.Unmarshaler
			 SelectAccountParams : encoding/json.Marshaler
			*SelectAccountParams : encoding/json.Unmarshaler
		As Outputs Of (at least one exported)
			func SelectAccount(dialogID string, accountIndex int64) *SelectAccountParams


Package-Level Functions (total 6)

	 func ConfirmIdpLogin(dialogID string) *ConfirmIdpLoginParams
		ConfirmIdpLogin only valid if the dialog type is ConfirmIdpLogin. Acts as
		if the user had clicked the continue button.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#method-confirmIdpLogin
		
		parameters:
		
			dialogID

	 func Disable() *DisableParams
		Disable [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#method-disable

	 func DismissDialog(dialogID string) *DismissDialogParams
		DismissDialog [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#method-dismissDialog
		
		parameters:
		
			dialogID

	 func Enable() *EnableParams
		Enable [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#method-enable
		
		parameters:

	 func ResetCooldown() *ResetCooldownParams
		ResetCooldown resets the cooldown time, if any, to allow the next FedCM
		call to show a dialog even if one was recently dismissed by the user.
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#method-resetCooldown

	 func SelectAccount(dialogID string, accountIndex int64) *SelectAccountParams
		SelectAccount [no description].
		
		See: https://chromedevtools.github.io/devtools-protocol/tot/FedCm#method-selectAccount
		
		parameters:
		
			dialogID
			accountIndex


Package-Level Constants (total 11)

	const CommandConfirmIdpLogin = "FedCm.confirmIdpLogin"
		Command names.

	const CommandDisable = "FedCm.disable"
		Command names.

	const CommandDismissDialog = "FedCm.dismissDialog"
		Command names.

	const CommandEnable = "FedCm.enable"
		Command names.

	const CommandResetCooldown = "FedCm.resetCooldown"
		Command names.

	const CommandSelectAccount = "FedCm.selectAccount"
		Command names.

	const DialogTypeAccountChooser DialogType = "AccountChooser"
		DialogType values.

	const DialogTypeAutoReauthn DialogType = "AutoReauthn"
		DialogType values.

	const DialogTypeConfirmIdpLogin DialogType = "ConfirmIdpLogin"
		DialogType values.

	const LoginStateSignIn LoginState = "SignIn"
		LoginState values.

	const LoginStateSignUp LoginState = "SignUp"
		LoginState values.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.