1"use strict";(self.webpackChunkfluid_framework_website=self.webpackChunkfluid_framework_website||[]).push([[2015],{838412:(e,s,n)=>{n.r(s),n.d(s,{assets:()=>o,contentTitle:()=>d,default:()=>c,frontMatter:()=>a,metadata:()=>r,toc:()=>l});const r=JSON.parse('{"id":"api/shared-summary-block/isharedsummaryblock-interface","title":"ISharedSummaryBlock Interface","description":"Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops. The set on this interface must only be called in response to a remote op. Basically, if we replay same ops, the set of calls on this interface to set data should be the same. This is critical because the object does not generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize.","source":"@site/versioned_docs/version-2/api/shared-summary-block/isharedsummaryblock-interface.md","sourceDirName":"api/shared-summary-block","slug":"/api/shared-summary-block/isharedsummaryblock-interface","permalink":"/docs/v2/api/shared-summary-block/isharedsummaryblock-interface","draft":false,"unlisted":false,"tags":[],"version":"2","frontMatter":{"title":"ISharedSummaryBlock Interface","sidebar_label":"ISharedSummaryBlock","displayed_sidebar":"docsSidebar"},"sidebar":"docsSidebar"}');var t=n(886070),i=n(403793);const a={title:"ISharedSummaryBlock Interface",sidebar_label:"ISharedSummaryBlock",displayed_sidebar:"docsSidebar"},d=void 0,o={},l=[{value:"Methods",id:"methods",level:2},{value:"Method Details",id:"method-details",level:2},{value:"Type Parameters",id:"type-parameters",level:5},{value:"Type Parameters",id:"type-parameters-1",level:5}];function h(e){const s={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(s.p,{children:"Shared summary block interface. A shared summary block is part of the summary but it does not generate any ops. The set on this interface must only be called in response to a remote op. Basically, if we replay same ops, the set of calls on this interface to set data should be the same. This is critical because the object does not generate ops of its own, but relies on the above principle to maintain eventual consistency and to summarize."}),"\n",(0,t.jsxs)(s.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:[(0,t.jsxs)(s.p,{children:["To use, import via ",(0,t.jsx)(s.code,{children:"@fluidframework/shared-summary-block/legacy"}),"."]}),(0,t.jsxs)(s.p,{children:["For more information about our API support guarantees, see ",(0,t.jsx)(s.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})]}),"\n",(0,t.jsx)(s.h2,{id:"isharedsummaryblock-signature",children:"Signature"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-typescript",children:"export interface ISharedSummaryBlock extends ISharedObject\n"})}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"Extends"}),": ",(0,t.jsx)(s.a,{href:"/docs/v2/api/shared-object-base/isharedobject-interface",children:"ISharedObject"})]}),"\n",(0,t.jsx)(s.h2,{id:"methods",children:"Methods"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Method"}),(0,t.jsx)(s.th,{children:"Alerts"}),(0,t.jsx)(s.th,{children:"Return Type"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/docs/v2/api/shared-summary-block/isharedsummaryblock-interface#get-methodsignature",children:"get(key)"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"Beta"})}),(0,t.jsxs)(s.td,{children:[(0,t.jsx)(s.a,{href:"/docs/v2/api/datastore-definitions/jsonable-typealias",children:"Jsonable"}),"<T>"]}),(0,t.jsx)(s.td,{children:"Retrieves the given key from the map."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:(0,t.jsx)(s.a,{href:"/docs/v2/api/shared-summary-block/isharedsummaryblock-interface#set-methodsignature",children:"set(key, value)"})}),(0,t.jsx)(s.td,{children:(0,t.jsx)(s.code,{children:"Beta"})}),(0,t.jsx)(s.td,{children:"void"}),(0,t.jsx)(s.td,{children:"Sets the value stored at key to the provided value."})]})]})]}),"\n",(0,t.jsx)(s.h2,{id:"method-details",children:"Method Details"}),"\n",(0,t.jsx)(s.h3,{id:"get-methodsignature",children:"get"}),"\n",(0,t.jsx)(s.p,{children:"Retrieves the given key from the map."}),"\n",(0,t.jsx)(s.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,t.jsxs)(s.p,{children:["For more information about our API support guarantees, see ",(0,t.jsx)(s.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,t.jsx)(s.h4,{id:"get-signature",children:"Signature"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-typescript",children:"get<T>(key: string): Jsonable<T>;\n"})}),"\n",(0,t.jsx)(s.h5,{id:"type-parameters",children:"Type Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"T"}),(0,t.jsx)(s.td,{})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"get-parameters",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Type"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"key"}),(0,t.jsx)(s.td,{children:"string"}),(0,t.jsx)(s.td,{children:"Key to retrieve from."})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"get-returns",children:"Returns"}),"\n",(0,t.jsx)(s.p,{children:"The stored value, or undefined if the key is not set."}),"\n",(0,t.jsxs)(s.p,{children:[(0,t.jsx)(s.strong,{children:"Return type"}),": ",(0,t.jsx)(s.a,{href:"/docs/v2/api/datastore-definitions/jsonable-typealias",children:"Jsonable"}),"<T>"]}),"\n",(0,t.jsx)(s.h3,{id:"set-methodsignature",children:"set"}),"\n",(0,t.jsx)(s.p,{children:"Sets the value stored at key to the provided value."}),"\n",(0,t.jsx)(s.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,t.jsxs)(s.p,{children:["For more information about our API support guarantees, see ",(0,t.jsx)(s.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,t.jsx)(s.h4,{id:"set-signature",children:"Signature"}),"\n",(0,t.jsx)(s.pre,{children:(0,t.jsx)(s.code,{className:"language-typescript",children:"set<T>(key: string, value: Jsonable<T>): void;\n"})}),"\n",(0,t.jsx)(s.h5,{id:"type-parameters-1",children:"Type Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsx)(s.tbody,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"T"}),(0,t.jsx)(s.td,{})]})})]}),"\n",(0,t.jsx)(s.h4,{id:"set-parameters",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,t.jsxs)(s.table,{children:[(0,t.jsx)(s.thead,{children:(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.th,{children:"Parameter"}),(0,t.jsx)(s.th,{children:"Type"}),(0,t.jsx)(s.th,{children:"Description"})]})}),(0,t.jsxs)(s.tbody,{children:[(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"key"}),(0,t.jsx)(s.td,{children:"string"}),(0,t.jsx)(s.td,{children:"Key to set at."})]}),(0,t.jsxs)(s.tr,{children:[(0,t.jsx)(s.td,{children:"value"}),(0,t.jsxs)(s.td,{children:[(0,t.jsx)(s.a,{href:"/docs/v2/api/datastore-definitions/jsonable-typealias",children:"Jsonable"}),"<T>"]}),(0,t.jsx)(s.td,{children:"Jsonable type value to set."})]})]})]})]})}function c(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,t.jsx)(s,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},403793:(e,s,n)=>{n.d(s,{R:()=>a,x:()=>d});var r=n(830758);const t={},i=r.createContext(t);function a(e){const s=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function d(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:a(e.components),r.createElement(i.Provider,{value:s},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.