mirror of
				https://github.com/superseriousbusiness/gotosocial.git
				synced 2025-11-03 18:02:26 -06:00 
			
		
		
		
	* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
		
			
				
	
	
		
			80 lines
		
	
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			80 lines
		
	
	
	
		
			3.1 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// GoToSocial
 | 
						|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
 | 
						|
// SPDX-License-Identifier: AGPL-3.0-or-later
 | 
						|
//
 | 
						|
// This program is free software: you can redistribute it and/or modify
 | 
						|
// it under the terms of the GNU Affero General Public License as published by
 | 
						|
// the Free Software Foundation, either version 3 of the License, or
 | 
						|
// (at your option) any later version.
 | 
						|
//
 | 
						|
// This program is distributed in the hope that it will be useful,
 | 
						|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
						|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
						|
// GNU Affero General Public License for more details.
 | 
						|
//
 | 
						|
// You should have received a copy of the GNU Affero General Public License
 | 
						|
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
						|
 | 
						|
package model
 | 
						|
 | 
						|
import "mime/multipart"
 | 
						|
 | 
						|
// Emoji represents a custom emoji.
 | 
						|
//
 | 
						|
// swagger:model emoji
 | 
						|
type Emoji struct {
 | 
						|
	// The name of the custom emoji.
 | 
						|
	// example: blobcat_uwu
 | 
						|
	Shortcode string `json:"shortcode"`
 | 
						|
	// Web URL of the custom emoji.
 | 
						|
	// example: https://example.org/fileserver/emojis/blogcat_uwu.gif
 | 
						|
	URL string `json:"url"`
 | 
						|
	// A link to a static copy of the custom emoji.
 | 
						|
	// example: https://example.org/fileserver/emojis/blogcat_uwu.png
 | 
						|
	StaticURL string `json:"static_url"`
 | 
						|
	// Emoji is visible in the emoji picker of the instance.
 | 
						|
	// example: true
 | 
						|
	VisibleInPicker bool `json:"visible_in_picker"`
 | 
						|
	// Used for sorting custom emoji in the picker.
 | 
						|
	// example: blobcats
 | 
						|
	Category string `json:"category,omitempty"`
 | 
						|
}
 | 
						|
 | 
						|
// EmojiCreateRequest represents a request to create a custom emoji made through the admin API.
 | 
						|
//
 | 
						|
// swagger:model emojiCreateRequest
 | 
						|
type EmojiCreateRequest struct {
 | 
						|
	// Desired shortcode for the emoji, without surrounding colons. This must be unique for the domain.
 | 
						|
	// example: blobcat_uwu
 | 
						|
	Shortcode string `form:"shortcode" validation:"required"`
 | 
						|
	// Image file to use for the emoji. Must be png or gif and no larger than 50kb.
 | 
						|
	Image *multipart.FileHeader `form:"image" validation:"required"`
 | 
						|
	// Category in which to place the new emoji. Will be uncategorized by default.
 | 
						|
	// CategoryName length should not exceed 64 characters.
 | 
						|
	CategoryName string `form:"category"`
 | 
						|
}
 | 
						|
 | 
						|
// EmojiUpdateRequest represents a request to update a custom emoji, made through the admin API.
 | 
						|
//
 | 
						|
// swagger:model emojiUpdateRequest
 | 
						|
type EmojiUpdateRequest struct {
 | 
						|
	// Type of action. One of disable, modify, copy.
 | 
						|
	Type EmojiUpdateType `form:"type" json:"type" xml:"type"`
 | 
						|
	// Desired shortcode for the emoji, without surrounding colons. This must be unique for the domain.
 | 
						|
	// example: blobcat_uwu
 | 
						|
	Shortcode *string `form:"shortcode"`
 | 
						|
	// Image file to use for the emoji.
 | 
						|
	// Must be png or gif and no larger than 50kb.
 | 
						|
	Image *multipart.FileHeader `form:"image"`
 | 
						|
	// Category in which to place the emoji.
 | 
						|
	CategoryName *string `form:"category"`
 | 
						|
}
 | 
						|
 | 
						|
// EmojiUpdateType models an admin update action to take on a custom emoji.
 | 
						|
type EmojiUpdateType string
 | 
						|
 | 
						|
const (
 | 
						|
	EmojiUpdateModify  EmojiUpdateType = "modify"  // modify local emoji
 | 
						|
	EmojiUpdateDisable EmojiUpdateType = "disable" // disable remote emoji
 | 
						|
	EmojiUpdateCopy    EmojiUpdateType = "copy"    // copy remote emoji -> local
 | 
						|
)
 |