csom

Documentation

Overview

Package csom helps building CSOM XML requests

Index

• type Action
  • func NewAction(template string) Action
  • func NewActionIdentityQuery() Action
  • func NewActionMethod(methodName string, parameters []string) Action
  • func NewQueryWithChildProps(properties []string) Action
  • func NewQueryWithProps(properties []string) Action
  • func NewSetProperty(propertyName string, parameter string) Action
• type Builder
  • func NewBuilder() Builder
• type Object
  • func NewObject(template string) Object
  • func NewObjectIdentity(identityPath string) Object
  • func NewObjectMethod(methodName string, parameters []string) Object
  • func NewObjectProperty(propertyName string) Object

Types

type Action

type Action interface {
	String() string
	SetID(id int)
	GetID() int
	SetObjectID(objectID int)
	GetObjectID() int
	CheckErr() error
}

Action CSOM XML action node builder interface

func NewAction

func NewAction(template string) Action

NewAction creates CSOM XML action node builder instance

func NewActionIdentityQuery

func NewActionIdentityQuery() Action

NewActionIdentityQuery creates CSOM XML action node builder instance

func NewActionMethod

func NewActionMethod(methodName string, parameters []string) Action

NewActionMethod creates CSOM XML action node builder instance

func NewQueryWithChildProps

func NewQueryWithChildProps(properties []string) Action

NewQueryWithChildProps creates CSOM XML query node builder instance

func NewQueryWithProps

func NewQueryWithProps(properties []string) Action

NewQueryWithProps creates CSOM XML query node builder instance

func NewSetProperty

func NewSetProperty(propertyName string, parameter string) Action

NewSetProperty creates CSOM XML set property action node builder instance

type Builder

type Builder interface {
	AddObject(object Object, parent Object) (Object, Object) // adds ObjectPath node to CSOM XML package
	AddAction(action Action, parent Object) (Action, Object) // adds Action node to CSOM XML package
	GetObjectID(object Object) (int, error)                  // gets provided object's ID, the object should be a pointer to already added ObjectPath node
	Compile() (string, error)                                // compiles CSOM XML package
	Clone() Builder                                          // returns object clone
	GetObjects() []Object                                    // get CSOM objects array
}

Builder CSOM packages builder interface

func NewBuilder

func NewBuilder() Builder

NewBuilder creates CSOM builder instance

type Object

type Object interface {
	String() string
	Template() string
	SetID(id int)
	GetID() int
	SetParentID(parentID int)
	GetParentID() int
	CheckErr() error
}

Object CSOM XML object path node builder interface

func NewObject

func NewObject(template string) Object

NewObject creates CSOM XML object path node builder instance

func NewObjectIdentity

func NewObjectIdentity(identityPath string) Object

NewObjectIdentity creates CSOM XML object path node builder instance

func NewObjectMethod

func NewObjectMethod(methodName string, parameters []string) Object

NewObjectMethod creates CSOM XML object path node builder instance

func NewObjectProperty

func NewObjectProperty(propertyName string) Object

NewObjectProperty creates CSOM XML object path node builder instance