diff --git a/cchat.go b/cchat.go index cd7de73..a9b0170 100644 --- a/cchat.go +++ b/cchat.go @@ -202,12 +202,18 @@ type Attachments interface { // break // success // } type Authenticator interface { + // Namer returns a short and concise name of this Authenticator method. The name + // should not include the name of the Service. + Namer + // Authenticate will be called with a list of values with indices correspond to // the returned slice of AuthenticateEntry. Authenticate([]string) (Session, error) // Blocking // AuthenticateForm should return a list of authentication entries for the // frontend to render. AuthenticateForm() []AuthenticateEntry + // Description returns the description of this authenticator method. + Description() text.Rich } // Author is the interface for an identifiable author. The interface defines diff --git a/repository/main.go b/repository/main.go index e4726e3..ae35c45 100644 --- a/repository/main.go +++ b/repository/main.go @@ -706,7 +706,26 @@ var Main = Packages{ } `}, Name: "Authenticator", + Embeds: []EmbeddedInterface{{ + Comment: Comment{` + Namer returns a short and concise name of this Authenticator + method. The name should not include the name of the Service. + `}, + InterfaceName: "Namer", + }}, Methods: []Method{ + GetterMethod{ + method: method{ + Comment: Comment{` + Description returns the description of this + authenticator method. + `}, + Name: "Description", + }, + Returns: []NamedType{{ + Type: MakeQual("text", "Rich"), + }}, + }, GetterMethod{ method: method{ Comment: Comment{`