go-frameproto/appendframebutton1action.go

45 lines
1.5 KiB
Go

package frameproto
// AppendFrameButton1Action will append the HTML <meta/> element for the Frame-Protocol's (i.e., Farcaster Frame's) "fc:frame:button:1:action" name-value pair.
//
// For example, this call:
//
// var p []byte
//
// // ..
//
// var buttonAction string = "post"
//
// p = frameproto.AppendFrameButton1Action(p, buttonAction)
//
// Would append this HTML <meta/> element:
//
// <meta property="fc:frame:button:1:action" content="post" />
//
// Note that this package provides some constants to use with AppendFrameButton1Action.
// Namely: ButtonActionLink (for "link"), ButtonActionMint (for "mint"), ButtonActionPost (for "post"), and ButtonActionPostRedirect (for "post_redirect").
//
// Which in code would be used as:
//
// // <meta property="fc:frame:button:1:action" content="link" />
// p = frameproto.AppendFrameButton1Action(p, frameproto.ButtonActionLink)
//
// And:
//
// // <meta property="fc:frame:button:1:action" content="mint" />
// p = frameproto.AppendFrameButton1Action(p, frameproto.ButtonActionMint)
//
// And:
//
// // <meta property="fc:frame:button:1:action" content="post" />
// str :+ frameproto.AppendFrameButton1Action(p, frameproto.ButtonActionPost)
//
// And:
//
// // <meta property="fc:frame:button:1:action" content="post_redirect" />
// p = frameproto.AppendFrameButton1Action(p, frameproto.ButtonActionPostRedirect)
func AppendFrameButton1Action(p []byte, action string) []byte {
const property string = MetaPropertyFrameButton1Action
return appendMetaPropertyContent(p, property, action)
}