package
0.0.0-20250310161452-f2ce0f3d0664
Repository: https://github.com/koltyakov/gosip.git
Documentation: pkg.go.dev

# Functions

EscapePathURI escapes URI path for GetFile and GetFolder methods.
ExtractEntityURI extracts REST entity URI from payload.
HasPermissions checks if base permissions include permissions kind mask permissionsKind is represented with in64 value (use PermissionKind struct helper as enumerator).
NewAssociatedGroups - AssociatedGroups struct constructor function.
NewAttachment - Attachment struct constructor function.
NewAttachments - Attachments struct constructor function.
NewChanges - Changes struct constructor function.
NewContentType - ContentType struct constructor function.
NewContentTypes - ContentTypes struct constructor function.
NewContext - Context struct constructor function.
NewCustomAction - CustomActions struct constructor function.
NewCustomActions - CustomActions struct constructor function.
NewEventReceivers - EventReceivers struct constructor function.
NewFeatures - Features struct constructor function.
NewField - Field struct constructor function.
NewFieldLink - FieldLink struct constructor function.
NewFieldLinks - FieldLinks struct constructor function.
NewFields - Fields struct constructor function.
NewFile - File struct constructor function.
NewFiles - Files struct constructor function.
NewFolder ...
NewFolders - Folders struct constructor function.
NewGroup - Group struct constructor function.
NewGroups - Groups struct constructor function.
NewHTTPClient creates an instance of httpClient.
NewItem - Item struct constructor function.
NewItems - Items struct constructor function.
NewList - List struct constructor function.
NewLists - Lists struct constructor function.
NewODataMods - ODataMods constructor function.
NewProfiles - Profiles struct constructor function.
NewProperties - Properties struct constructor function.
NewRecords - Records struct constructor function.
NewRecycleBin - RecycleBin struct constructor function.
NewRecycleBinItem - RecycleBinItem struct constructor function.
NewRoleDefinitions - RoleDefinitions struct constructor function.
NewRoles - Roles struct constructor function.
NewSearch - Search struct constructor function.
NewSite - Site struct constructor function.
NewSP - SP struct constructor function.
NewSubscription - subscription struct constructor function.
NewSubscriptions - Subscriptions struct constructor function.
NewTaxonomy - taxonomy struct constructor function.
NewUser - User struct constructor function.
NewUsers - Users struct constructor function.
NewUtility - Utility struct constructor function.
NewView - View struct constructor function.
NewViews - Views struct constructor function.
NewWeb - Web struct constructor function.
NewWebs - Webs struct constructor function.
NormalizeODataCollection parses OData resp taking care of OData mode.
NormalizeODataItem parses OData resp taking care of OData mode.
TrimMultiline trims multiline string converting to a single line friendly for payloads.

# Variables

CheckInTypes - available check in types.
HeadersPresets : SP REST OData headers presets.
PermissionKind enumerator.
RoleTypeKinds defined standard role type kinds.

# Structs

AddChunkedOptions provides optional settings for AddChunked method.
AddValidateFieldResult field result struct.
AssociatedGroups web associated groups scope constructor Always use NewAssociatedGroups constructor instead of &AssociatedGroups{}.
Attachment represents SharePoint List Items Attachment API queryable object struct Always use NewAttachment constructor instead of &Attachment{}.
AttachmentInfo - attachment API response payload structure.
Attachments represent SharePoint List Items Attachments API queryable collection struct Always use NewAttachments constructor instead of &Attachments{}.
BasePermissions - Low/High pair of base permissions.
ChangeInfo - changes API response payload structure.
ChangeQuery ...
Changes represent SharePoint Changes API queryable collection struct Always use NewChanges constructor instead of &Changes{}.
ChangesResp - changes response type with helper processor methods.
ContentType represents SharePoint Content Types API queryable object struct Always use NewContentType constructor instead of &ContentType{}.
ContentTypeCreationInfo new content type metadata.
ContentTypeInfo - content type API response payload structure.
ContentTypes represent SharePoint Content Types API queryable collection struct Always use NewContentTypes constructor instead of &ContentTypes{}.
Context represents SharePoint Content Info API object struct Always use NewContext constructor instead of &Context{}.
ContextInfo - context info response payload structure.
CustomAction represent SharePoint CustomAction API object Always use NewCustomAction constructor instead of &CustomAction{}.
CustomActionInfo - user custom actions API response payload structure.
CustomActions represent SharePoint CustomActions API queryable collection struct Always use NewCustomActions constructor instead of &CustomActions{}.
DecodedURL decode URL prop type.
EmailProps struct for SendEmail method parameters.
EventReceiverInfo - event receivers API response payload structure.
EventReceivers represent SharePoint EventReceivers API queryable collection struct Always use NewEventReceivers constructor instead of &EventReceivers{}.
FeatureInfo - features API response payload structure.
Features represent SharePoint Webs & Site Features API queryable collection struct Always use NewFeatures constructor instead of &Features{}.
Field represents SharePoint Field (Site Column) API queryable object struct Always use NewField constructor instead of &Field{}.
FieldInfo - generic field API response payload structure.
FieldLink represent SharePoint content type FieldLink API Always use NewFieldLink constructor instead of &FieldLink{}.
FieldLinkInfo field link info.
FieldLinks represent SharePoint content type FieldLinks API queryable collection struct Always use NewFieldLinks constructor instead of &FieldLinks{}.
Fields represent SharePoint Fields (Site Columns) API queryable collection struct Always use NewFields constructor instead of &Fields{}.
File represents SharePoint File API queryable object struct Always use NewFile constructor instead of &File{}.
FileInfo - file API response payload structure.
Files represent SharePoint Files API queryable collection struct Always use NewFiles constructor instead of &Files{}.
FileUploadProgressData describes Progress callback options.
Folder represents SharePoint Lists & Document Libraries Folder API queryable object struct Always use NewFolder constructor instead of &Folder{}.
FolderInfo - folder API response payload structure.
Folders represent SharePoint Lists & Document Libraries Folders API queryable collection struct Always use NewFolders constructor instead of &Folders{}.
GenericItemInfo - list's generic item response payload structure.
Group represents SharePoint Site Groups API queryable object struct Always use NewGroup constructor instead of &Group{}.
GroupInfo - site group API response payload structure.
Groups represent SharePoint Site Groups API queryable collection struct Always use NewGroups constructor instead of &Groups{}.
HTTPClient HTTP methods helper.
Item represents SharePoint Lists & Document Libraries Items API queryable object struct Always use NewItem constructor instead of &Item{}.
Items represent SharePoint Lists & Document Libraries Items API queryable collection struct Always use NewItems constructor instead of &Items{}.
ItemsPage - paged items.
List represents SharePoint List API queryable object struct Always use NewList constructor instead of &List{}.
ListInfo - list instance response payload structure.
Lists represent SharePoint Lists API queryable collection struct Always use NewLists constructor instead of &Lists{}.
ODataMods - REST OData Modifiers struct.
ProfileInfo - user profile API response payload structure.
ProfilePropsInto ...
Profiles represent SharePoint User Profiles API queryable collection struct Always use NewProfiles constructor instead of &Profiles{}.
Properties represent SharePoint Property Bags API queryable collection struct Always use NewProperties constructor instead of &Properties{}.
Records represents SharePoint Item Records via REST+CSOM API object struct Always use NewRecords constructor instead of &Records{}.
RecycleBin represents SharePoint Recycle Bin API queryable collection struct Always use NewRecycleBin constructor instead of &RecycleBin{}.
RecycleBinItem represent SharePoint Recycle Bin Item API queryable object struct Always use NewRecycleBinItem constructor instead of &RecycleBinItem{}.
RecycleBinItemInfo ...
RenderListDataInfo ...
RequestConfig struct.
ResultTable - search result table type.
ResultTableCollection - search results table collection type.
RoleAssigment role assignments model.
RoleDefInfo - permissions role definition API response payload structure.
RoleDefinitions represents SharePoint permissions Role Definitions API queryable object struct Always use NewRoleDefinitions constructor instead of &RoleDefinitions{}.
Roles represent SharePoint Permissions Roles API queryable collection struct Always use NewRoles constructor instead of &Roles{}.
Search represents SharePoint Search API object struct Always use NewSearch constructor instead of &Search{}.
SearchProperty - search property type.
SearchPropertyValue - search property value type.
SearchQuery - strongly typed struct for search method parameters.
SearchReorderingRule - search reordering rule type.
SearchResults - search results response type.
SearchSort - search sort property type.
Site represents SharePoint Site API queryable object struct Always use NewSite constructor instead of &Site{}.
SiteInfo - site API response payload structure.
SP represents SharePoint REST+ API root struct Always use NewSP constructor instead of &SP{}.
StringValue single value prop type.
Subscription represent SharePoint lists Subscription API Always use NewSubscription constructor instead of &Subscription{}.
SubscriptionInfo list subscription info.
Subscriptions represent SharePoint lists Subscriptions API queryable collection struct Always use NewSubscriptions constructor instead of &Subscriptions{}.
Taxonomy session struct.
Term struct.
TermGroup term group struct.
TermGroups term groups struct.
Terms struct.
TermSet term set struct.
TermSets term sets struct.
TermStore term store struct.
TermStores term stores struct.
TypedKeyValue typed key value prop type.
UpdateValidateFieldResult field result struct.
User represents SharePoint Site User API queryable object struct Always use NewUser constructor instead of &User{}.
UserInfo - site user API response payload structure.
Users represent SharePoint Site Users API queryable collection struct Always use NewUsers constructor instead of &Users{}.
Utility represents SharePoint Utilities namespace API object struct Always use NewUtility constructor instead of &Utility{}.
ValidateAddOptions AddValidateUpdateItemUsingPath method options.
ValidateUpdateOptions ValidateUpdateListItem request options.
View represents SharePoint List View API queryable object struct Always use NewView constructor instead of &View{}.
ViewInfo - list view API response payload structure.
Views represent SharePoint List Views API queryable collection struct Always use NewViews constructor instead of &Views{}.
Web represents SharePoint Web API queryable object struct Always use NewWeb constructor instead of &Web{}.
WebhookInfo represents webhook payload object structure.
WebInfo - web API response payload structure.
Webs represent SharePoint Webs API queryable collection struct Always use NewWebs constructor instead of &Webs{}.

# Type aliases

AddValidateResp - add validate using path response type with helper processor methods.
AttachmentResp - attachment response type with helper processor methods.
AttachmentsResp - attachments response type with helper processor methods.
ContentTypeResp - content type response type with helper processor methods.
ContentTypesResp - content types response type with helper processor methods.
FieldLinkResp - fieldLinks response type with helper processor methods.
FieldLinksResp - fieldLinks response type with helper processor methods.
FieldResp - field response type with helper processor methods.
FieldsResp - fields response type with helper processor methods.
FileResp - file response type with helper processor methods.
FilesResp - files response type with helper processor methods.
FolderResp - folder response type with helper processor methods.
FoldersResp - folders response type with helper processor methods.
GroupResp - group response type with helper processor methods.
GroupsResp - groups response type with helper processor methods.
ItemResp - item response type with helper processor methods.
ItemsResp - items response type with helper processor methods.
ListItemAllFieldsResp - item fields response type with helper processor methods.
ListResp - list response type with helper processor methods.
ListsResp - lists response type with helper processor methods.
ProfilePropsResp - user profile props response type with helper processor methods.
ProfileResp - user profile response type with helper processor methods.
PropsResp - property bags response type with helper processor methods.
RecycleBinItemResp - recycle bin item response type with helper processor methods.
RecycleBinResp - recycle bin response type with helper processor methods.
RenderListDataResp - renderListData method response type with helper processor methods.
SearchResp - search response type with helper processor methods.
SiteResp - site response type with helper processor methods.
UpdateValidateResp - update validate response type with helper processor methods.
UserResp - site user response type with helper processor methods.
UsersResp - site users response type with helper processor methods.
ViewResp - list view response type with helper processor methods.
ViewsResp - list views response type with helper processor methods.
WebResp - web response type with helper processor methods.
WebsResp - webs response type with helper processor methods.